tmux_interface/commands/clients_and_sessions/
list_sessions.rs

1use crate::commands::constants::*;
2use crate::TmuxCommand;
3use std::borrow::Cow;
4use std::marker::PhantomData;
5
6pub type Ls<'a> = ListSessions<'a>;
7
8// XXX: better result return?
9/// List all sessions managed by the server
10/// # Manual
11///
12/// tmux ^3.4:
13/// ```text
14/// list-sessions [-F format] [-f filter]
15/// (alias: ls)
16/// ```
17///
18/// tmux ^1.6:
19/// ```text
20/// list-sessions [-F format]
21/// (alias: ls)
22/// ```
23///
24/// tmux ^0.8:
25/// ```text
26/// list-sessions
27/// (alias: ls)
28/// ```
29#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
30pub struct ListSessions<'a> {
31    /// `[-F format]`
32    #[cfg(feature = "tmux_1_6")]
33    pub format: Option<Cow<'a, str>>,
34
35    /// `[-f filter]`
36    #[cfg(feature = "tmux_3_4")]
37    pub filter: Option<Cow<'a, str>>,
38
39    _phantom_data: PhantomData<&'a ()>,
40}
41
42impl<'a> ListSessions<'a> {
43    pub fn new() -> Self {
44        Default::default()
45    }
46
47    /// `[-F format]`
48    #[cfg(feature = "tmux_1_6")]
49    pub fn format<S: Into<Cow<'a, str>>>(mut self, format: S) -> Self {
50        self.format = Some(format.into());
51        self
52    }
53
54    /// `[-f filter]`
55    #[cfg(feature = "tmux_3_4")]
56    pub fn filter<S: Into<Cow<'a, str>>>(mut self, filter: S) -> Self {
57        self.filter = Some(filter.into());
58        self
59    }
60
61    pub fn build(self) -> TmuxCommand<'a> {
62        let mut cmd = TmuxCommand::new();
63
64        cmd.name(LIST_SESSIONS);
65
66        // `[-F format]`
67        #[cfg(feature = "tmux_1_6")]
68        if let Some(format) = self.format {
69            cmd.push_option(F_UPPERCASE_KEY, format);
70        }
71
72        // `[-f filter]`
73        #[cfg(feature = "tmux_3_4")]
74        if let Some(filter) = self.filter {
75            cmd.push_option(F_LOWERCASE_KEY, filter);
76        }
77
78        cmd
79    }
80}
tmux_interface/commands/clients_and_sessions/list_sessions.rs

tmux_interface/commands/clients_and_sessions/
list_sessions.rs
