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

use crate::{ShowOptions, TmuxCommand};
use std::borrow::Cow;

/// Common trait for getting options, using [`ShowOptions`] command.
///
// Allows different implementations for different objects options:
//
//  * [`ServerOptions`] (`show-options -s <NAME>`)
//  * [`SessionOptions`] (`show-options <NAME>`)
//  * [`WindowOptions`] (`show-options -w <NAME>`)
//  * [`PaneOptions`] (`show-options -p <NAME>`)
//
// NOTE: `GetOptionTr` complementary to `SetOptionTr`, symbols `SetOption`
// already taken by tmux command builder
pub trait GetOptionTr {
    /// Command builder for get single option command using only option name
    ///
    /// # Arguments
    ///
    /// * `name` - option name
    ///
    /// # Manual
    ///
    /// ```text
    /// show-options name
    /// ```
    fn get<'a, S>(name: S) -> TmuxCommand<'a>
    where
        S: Into<Cow<'a, str>>,
    {
        ShowOptions::new().option(name).build()
    }

    /// Command builder for get single option command using target and option name
    ///
    /// # Arguments
    ///
    /// * `target` - optional target server/session/window/pane
    /// * `name` - option name
    ///
    /// # Manual
    ///
    /// ```text
    /// show-options [-t target] name
    /// ```
    fn get_ext<'a, T, S>(target: Option<S>, name: T) -> TmuxCommand<'a>
    where
        T: Into<Cow<'a, str>>,
        S: Into<Cow<'a, str>>,
    {
        let cmd = ShowOptions::new().option(name);
        let cmd = match target {
            Some(target) => cmd.target(target),
            None => cmd,
        };
        cmd.build()
    }

    /// Command builder for get all options command without specifying option name
    ///
    /// # Arguments
    ///
    /// * `target` - target server/session/window/pane
    ///
    /// # Manual
    ///
    /// ```text
    /// show-options [-t target]
    /// ```
    fn get_all<'a, S>(target: Option<S>) -> TmuxCommand<'a>
    where
        S: Into<Cow<'a, str>>,
    {
        let cmd = ShowOptions::new();
        let cmd = match target {
            Some(target) => cmd.target(target),
            None => cmd,
        };
        cmd.build()
    }
}