tmux-lib 0.5.0

Tmux helper functions.
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
150
151

//! Window Id.

use std::str::FromStr;

use nom::{
    IResult, Parser,
    character::complete::{char, digit1},
    combinator::all_consuming,
    sequence::preceded,
};
use serde::{Deserialize, Serialize};

use crate::error::{Error, map_add_intent};

/// The id of a Tmux window.
///
/// This wraps the raw tmux representation (`@41`).
///
/// ```
/// use std::str::FromStr;
/// use tmux_lib::window_id::WindowId;
///
/// let id = WindowId::from_str("@10").unwrap();
/// assert_eq!(id.as_str(), "@10");
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct WindowId(String);

impl FromStr for WindowId {
    type Err = Error;

    /// Parse into WindowId. The `&str` must start with '@' followed by a
    /// `u16`.
    fn from_str(input: &str) -> std::result::Result<Self, Self::Err> {
        let desc = "WindowId";
        let intent = "##{window_id}";

        let (_, window_id) = all_consuming(parse::window_id)
            .parse(input)
            .map_err(|e| map_add_intent(desc, intent, e))?;

        Ok(window_id)
    }
}

impl WindowId {
    /// Extract a string slice containing the raw representation.
    #[must_use]
    pub fn as_str(&self) -> &str {
        &self.0
    }
}

pub(crate) mod parse {
    use super::*;

    pub(crate) fn window_id(input: &str) -> IResult<&str, WindowId> {
        let (input, digit) = preceded(char('@'), digit1).parse(input)?;
        let id = format!("@{digit}");
        Ok((input, WindowId(id)))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_parse_window_id_fn() {
        let actual = parse::window_id("@43");
        let expected = Ok(("", WindowId("@43".into())));
        assert_eq!(actual, expected);

        let actual = parse::window_id("@4");
        let expected = Ok(("", WindowId("@4".into())));
        assert_eq!(actual, expected);
    }

    #[test]
    fn test_parse_window_id_struct() {
        let actual = WindowId::from_str("@43");
        assert!(actual.is_ok());
        assert_eq!(actual.unwrap(), WindowId("@43".into()));

        let actual = WindowId::from_str("4:38");
        assert!(matches!(
            actual,
            Err(Error::ParseError {
                desc: "WindowId",
                intent: "##{window_id}",
                err: _
            })
        ));
    }

    #[test]
    fn test_parse_window_id_with_large_number() {
        let window_id = WindowId::from_str("@99999").unwrap();
        assert_eq!(window_id.as_str(), "@99999");
    }

    #[test]
    fn test_parse_window_id_zero() {
        let window_id = WindowId::from_str("@0").unwrap();
        assert_eq!(window_id.as_str(), "@0");
    }

    #[test]
    fn test_parse_window_id_fails_on_wrong_prefix() {
        // $ is for session, % is for pane
        assert!(WindowId::from_str("$1").is_err());
        assert!(WindowId::from_str("%1").is_err());
    }

    #[test]
    fn test_parse_window_id_fails_on_no_prefix() {
        assert!(WindowId::from_str("123").is_err());
    }

    #[test]
    fn test_parse_window_id_fails_on_empty() {
        assert!(WindowId::from_str("").is_err());
        assert!(WindowId::from_str("@").is_err());
    }

    #[test]
    fn test_parse_window_id_fails_on_non_numeric() {
        assert!(WindowId::from_str("@abc").is_err());
        assert!(WindowId::from_str("@12abc").is_err());
    }

    #[test]
    fn test_parse_window_id_fails_on_extra_content() {
        // all_consuming should reject trailing content
        assert!(WindowId::from_str("@12:extra").is_err());
    }

    #[test]
    fn test_window_id_as_str() {
        let window_id = WindowId::from_str("@42").unwrap();
        assert_eq!(window_id.as_str(), "@42");
    }

    #[test]
    fn test_window_id_leaves_remaining_in_parser() {
        // The parse function (not FromStr) should leave remaining input
        let (remaining, window_id) = parse::window_id("@42:rest").unwrap();
        assert_eq!(remaining, ":rest");
        assert_eq!(window_id, WindowId("@42".into()));
    }
}