tmuxctl 0.1.0

A bidirectional tmux control-mode (tmux -C) client: typed notification stream, command reply correlation, pane-output decoding, and layout-tree parsing.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//! Shared spawn configuration for the runtime drivers (not the sans-IO core).
//!
//! Both the `blocking` and `tokio` drivers build the same `tmux -C` command line;
//! the argv lives here so neither duplicates it.

/// 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.
#[derive(Debug, Clone)]
#[non_exhaustive]
pub struct SpawnOpts {
    /// The tmux binary to run.
    pub program: String,
    /// Server socket name for `-L` (isolation); `None` uses tmux's default server.
    pub socket: Option<String>,
    /// Session for `-s` (with `new-session -A`, attach-or-create); `None` leaves it unnamed.
    pub session: Option<String>,
}

impl Default for SpawnOpts {
    fn default() -> Self {
        Self {
            program: "tmux".to_string(),
            socket: None,
            session: None,
        }
    }
}

impl SpawnOpts {
    /// 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 new() -> Self {
        Self::default()
    }

    /// Set the tmux binary to run.
    pub fn program(mut self, program: impl Into<String>) -> Self {
        self.program = program.into();
        self
    }

    /// Run on a dedicated server socket (`-L`) — use this for test isolation.
    pub fn socket(mut self, socket: impl Into<String>) -> Self {
        self.socket = Some(socket.into());
        self
    }

    /// Attach-or-create this named session (`-s`, with `new-session -A`).
    pub fn session(mut self, session: impl Into<String>) -> Self {
        self.session = Some(session.into());
        self
    }

    /// The argv after the program name: `[-L <socket>] -C new-session -A [-s <session>]`.
    /// Control mode (`-C`), never `-CC`.
    pub fn argv(&self) -> Vec<String> {
        let mut argv = Vec::new();
        if let Some(socket) = &self.socket {
            argv.push("-L".to_string());
            argv.push(socket.clone());
        }
        argv.push("-C".to_string());
        argv.push("new-session".to_string());
        argv.push("-A".to_string());
        if let Some(session) = &self.session {
            argv.push("-s".to_string());
            argv.push(session.clone());
        }
        argv
    }
}