config.Workspace
This type appears in public signatures. It is not a package entry point.
-
One workspace: a session and the windows it should contain.
Guides#
Pages that discuss Workspace.
In other ports#
Describe a workspace as data
| Language | Equivalent |
|---|---|
| Python | tmuxp uses configuration dictionaries rather than a dedicated workspace value type |
| Ruby | Lib |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | config |
| Go | workspace |
| Java | io |
| C# | Lib |
| C++ | libtmux:: |
| Swift | Workspace |
| OCaml | Libtmux |
| Perl | Lib Validates and copies a libtmux.workspace/v1 JSON-compatible configuration. |
No equivalent is recorded in Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.
Fields9#
| Name | Type | Description |
|---|---|---|
| session_name | String | The session name to create. |
| start_directory | Option<Path | A working directory inherited by windows that do not set their own. |
| environment | Vec<(String, String)> | Environment variables to set on the session. |
| options | Vec<(String, String)> | Session options to apply once the session exists. |
| global_options | Vec<(String, String)> | Global options to apply once the session exists. |
| shell_command_before | Vec<Shell | Commands run in every pane before its own, in order. |
| suppress_history | bool | Whether to keep pane commands out of the shell's history. |
| windows | Vec<Window | The windows to create, in order. |
| unsupported_keys | Vec<String> | Keys this parser recognized but does not act on. |
Other members5#
Common operations4#
- to_yaml method Render this workspace as tmuxp-style YAML.
- from_yaml method Parse one workspace from tmuxp-style YAML.
- from_yaml_strict method Parse as
Self::from_yaml()does, refusing a key that is neither this parser's own vocabulary nor tmuxp's, unless it starts withx-. - from_file method Read and parse one workspace file, as
tmuxp loaddoes.
Other members1#
- from_file_strict method Read as
Self::from_file()does, underSelf::from_yaml_strict()'s policy.