tmux_interface 0.3.2

Rust language library for communication with TMUX via CLI
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use crate::commands::constants::*;
use crate::TmuxCommand;
use std::borrow::Cow;

pub type Run<'a> = RunShell<'a>;

/// # Manual
///
/// tmux ^3.2:
/// ```text
/// run-shell [-bC] [-d delay] [-t target-pane] [shell-command]
/// (alias: run)
/// ```
///
/// tmux ^1.8:
/// ```text
/// run-shell [-b] [-t target-pane] shell-command
/// (alias: run)
/// ```
///
/// tmux ^1.2:
/// ```text
/// run-shell shell-command
/// (alias: run)
/// ```
///
/// tmux ^1.1:
/// ```text
/// run-shell command
/// (alias: run)
/// ```
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
pub struct RunShell<'a> {
    /// `[-b]`
    #[cfg(feature = "tmux_1_8")]
    pub background: bool,

    /// `[-C]` - execute tmux command
    #[cfg(feature = "tmux_3_2")]
    pub tmux_command: bool,

    /// `[-d delay]`
    #[cfg(feature = "tmux_1_8")]
    pub delay: Option<usize>,

    /// `[-t target-pane]`
    #[cfg(feature = "tmux_1_8")]
    pub target_pane: Option<Cow<'a, str>>,

    /// `shell-command`
    #[cfg(feature = "tmux_1_2")]
    pub shell_command: Option<Cow<'a, str>>,

    /// `command`
    #[cfg(all(feature = "tmux_1_1", not(feature = "tmux_1_2")))]
    pub command: Option<Cow<'a, str>>,
}

impl<'a> RunShell<'a> {
    pub fn new() -> Self {
        Default::default()
    }

    /// `[-b]`
    #[cfg(feature = "tmux_1_8")]
    pub fn background(mut self) -> Self {
        self.background = true;
        self
    }

    /// `[-C]` - execute tmux command
    #[cfg(feature = "tmux_3_2")]
    pub fn tmux_command(mut self) -> Self {
        self.tmux_command = true;
        self
    }

    /// `[-d delay]`
    #[cfg(feature = "tmux_1_8")]
    pub fn delay(mut self, delay: usize) -> Self {
        self.delay = Some(delay);
        self
    }

    /// `[-t target-pane]`
    #[cfg(feature = "tmux_1_8")]
    pub fn target_pane<S: Into<Cow<'a, str>>>(mut self, target_pane: S) -> Self {
        self.target_pane = Some(target_pane.into());
        self
    }

    /// `shell-command`
    #[cfg(feature = "tmux_1_2")]
    pub fn shell_command<S: Into<Cow<'a, str>>>(mut self, shell_command: S) -> Self {
        self.shell_command = Some(shell_command.into());
        self
    }

    /// `command`
    #[cfg(all(feature = "tmux_1_1", not(feature = "tmux_1_2")))]
    pub fn command<S: Into<Cow<'a, str>>>(mut self, command: S) -> Self {
        self.command = Some(command.into());
        self
    }

    pub fn build(self) -> TmuxCommand<'a> {
        let mut cmd = TmuxCommand::new();

        cmd.name(RUN_SHELL);

        // `[-b]`
        #[cfg(feature = "tmux_1_8")]
        if self.background {
            cmd.push_flag(B_LOWERCASE_KEY);
        }

        // `[-C]` - execute tmux command
        #[cfg(feature = "tmux_3_2")]
        if self.tmux_command {
            cmd.push_flag(C_UPPERCASE_KEY);
        }

        // `[-d delay]`
        #[cfg(feature = "tmux_1_8")]
        if let Some(delay) = self.delay {
            cmd.push_option(D_LOWERCASE_KEY, delay.to_string());
        }

        // `[-t target-pane]`
        #[cfg(feature = "tmux_1_8")]
        if let Some(target_pane) = self.target_pane {
            cmd.push_option(T_LOWERCASE_KEY, target_pane);
        }

        // `shell-command`
        #[cfg(feature = "tmux_1_2")]
        if let Some(shell_command) = self.shell_command {
            cmd.push_param(shell_command);
        }

        // `command`
        #[cfg(all(feature = "tmux_1_1", not(feature = "tmux_1_2")))]
        if let Some(command) = self.command {
            cmd.push_param(command);
        }

        cmd
    }
}