Skip to main content

PaneConfig

Struct PaneConfig 

Source
pub struct PaneConfig {
    pub shell_command_before: Vec<ShellCommand>,
    pub shell_commands: Vec<ShellCommand>,
    pub environment: Option<Vec<(String, String)>>,
    pub start_directory: Option<PathBuf>,
    pub focus: bool,
    pub shell: Option<String>,
    pub enter: bool,
    pub sleep_before: Option<Duration>,
    pub sleep_after: Option<Duration>,
    pub suppress_history: Option<bool>,
    pub unsupported_keys: Vec<String>,
}
Expand description

One pane.

The default is a pane that runs nothing and would press Enter after anything it were given, which is what tmuxp’s - pane, - blank and an empty - all mean.

Fields§

§shell_command_before: Vec<ShellCommand>

Commands run in this pane before Self::shell_commands, in order, after the workspace’s and the window’s own WindowConfig::shell_command_before.

§shell_commands: Vec<ShellCommand>

Commands to run in the pane once it exists.

§environment: Option<Vec<(String, String)>>

Environment variables set for the process this pane starts.

None inherits the window’s WindowConfig::environment wholesale; Some, even an empty one, replaces it rather than adding to it, as tmuxp does.

§start_directory: Option<PathBuf>

The pane’s working directory.

§focus: bool

Whether this pane should end up selected.

§shell: Option<String>

A command that replaces this pane’s shell, overriding WindowConfig::window_shell when both are given.

§enter: bool

Whether to press Enter after each command, until a command sets its own ShellCommand::enter.

tmuxp’s enter: false types a command without running it, which is how a file leaves something ready for the user to review. It covers the shell_command_before commands typed into this pane too.

§sleep_before: Option<Duration>

How long to wait before each command, until a command sets its own.

§sleep_after: Option<Duration>

How long to wait after each command, until a command sets its own.

§suppress_history: Option<bool>

Whether this pane’s commands stay out of the shell’s history.

None inherits the window, then the workspace.

§unsupported_keys: Vec<String>

Keys this parser recognized on the pane but does not act on.

Trait Implementations§

Source§

impl Clone for PaneConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PaneConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for PaneConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for PaneConfig

Source§

impl PartialEq for PaneConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PaneConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.