Struct SplitOptions 

pub struct SplitOptions { /* private fields */ }

Options for splitting a window or pane into a new pane.

A bare SplitDirection is accepted wherever this is: window.split(SplitDirection::Below).

Examples

use libtmux::{SplitDirection, SplitOptions};

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("split").await?;
let window = session.active_window().await?.expect("a session has a window");

// Splitting leaves focus where it was unless asked otherwise, so a caller
// that wants the new pane selected says so.
let pane = window
    .split(SplitOptions::new(SplitDirection::Right).select())
    .await?;
assert_eq!(window.active_pane().await?.map(|active| active.id().to_string()),
           Some(pane.id().to_string()));

guard.shutdown().await?;

Implementations

impl SplitOptions

pub const fn new(direction: SplitDirection) -> Self

Describe a split placing the new pane in one direction.

pub fn start_directory(self, directory: impl Into<PathBuf>) -> Self

Set the new pane’s working directory.

pub fn command(self, command: impl Into<OsString>) -> Self

Run a command instead of the default shell.

pub const fn size(self, size: PaneSize) -> Self

Give the new pane a size, in cells or as a share of the space.

pub fn environment( self, name: impl Into<OsString>, value: impl Into<OsString>, ) -> Self

Set an environment variable for the process the new pane starts.

Call this more than once for more than one variable. tmux applies these to the new process only, not to the session.

pub const fn full(self) -> Self

Span the full width or height of the window rather than of the pane.

pub const fn zoom(self) -> Self

Zoom the new pane, filling the window until it is unzoomed.

pub const fn select(self) -> Self

Make the new pane active.

Trait Implementations

impl Clone for SplitOptions

fn clone(&self) -> SplitOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SplitOptions

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

Formats the value using the given formatter.

impl From<SplitDirection> for SplitOptions

fn from(direction: SplitDirection) -> Self

Converts to this type from the input type.