Struct SpawnOpts 

#[non_exhaustive]
pub struct SpawnOpts {
    pub program: String,
    pub socket: Option<String>,
    pub session: Option<String>,
}

How to spawn the tmux -C control client. Default runs tmux -C new-session -A (attach-or-create the default session) on the default server.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

program: String

The tmux binary to run.

socket: Option<String>

Server socket name for -L (isolation); None uses tmux’s default server.

session: Option<String>

Session for -s (with new-session -A, attach-or-create); None leaves it unnamed.

Implementations

impl SpawnOpts

pub fn new() -> Self

Start from the defaults (tmux -C new-session -A, default server). SpawnOpts is #[non_exhaustive], so build it through these setters rather than a literal.

pub fn program(self, program: impl Into<String>) -> Self

Set the tmux binary to run.

pub fn socket(self, socket: impl Into<String>) -> Self

Run on a dedicated server socket (-L) — use this for test isolation.

pub fn session(self, session: impl Into<String>) -> Self

Attach-or-create this named session (-s, with new-session -A).

pub fn argv(&self) -> Vec<String>

The argv after the program name: [-L <socket>] -C new-session -A [-s <session>]. Control mode (-C), never -CC.

Trait Implementations

impl Clone for SpawnOpts

fn clone(&self) -> SpawnOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpawnOpts

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

Formats the value using the given formatter.

impl Default for SpawnOpts

fn default() -> Self

Returns the “default value” for a type.