skim 4.9.0

Fuzzy Finder in rust!
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

use std::time::Instant;

/// Default inline info separator
pub const DEFAULT_SEPARATOR: &str = "  < ";
pub(crate) const SPINNER_DURATION: u32 = 200;
pub(crate) const SPINNERS_UNICODE: [char; 10] = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];

pub(crate) fn spinner_char(start: Instant) -> char {
    let spinner_elapsed_ms = start.elapsed().as_millis();
    let index = ((spinner_elapsed_ms / u128::from(SPINNER_DURATION)) % (SPINNERS_UNICODE.len() as u128)) as usize;
    SPINNERS_UNICODE[index]
}

/// Simplified display mode for the info/status line
#[derive(Debug, Clone, Default, Eq, PartialEq)]
pub enum InfoDisplay {
    /// Display info in a separate line (default)
    #[default]
    Default,
    /// Display info inline with the input
    Inline,
    /// Hide the info display
    Hidden,
    /// Inline and right-aligned
    InlineRight,
}
impl InfoDisplay {
    pub(crate) fn is_inline(&self) -> bool {
        matches!(self, InfoDisplay::Inline | InfoDisplay::InlineRight)
    }
}

/// Full display mode for the info/status line
#[derive(Debug, Clone, Default, Eq, PartialEq)]
pub struct Info {
    /// The `InfoDisplay`
    pub display: InfoDisplay,
    /// The separator, specified if the display is inline
    pub separator: Option<String>,
}

impl Info {
    pub(crate) fn separator(&self) -> Option<&str> {
        self.separator.as_deref()
    }
}

impl From<InfoDisplay> for Info {
    fn from(value: InfoDisplay) -> Self {
        let is_inline = value.is_inline();
        Self {
            display: value,
            separator: if is_inline {
                Some(String::from(DEFAULT_SEPARATOR))
            } else {
                None
            },
        }
    }
}

impl From<&str> for Info {
    fn from(s: &str) -> Self {
        use InfoDisplay::{Default, Hidden, Inline, InlineRight};
        let mut parts = s.split(':');

        let display = match parts.next() {
            None | Some("default") => Default,
            Some("inline") => Inline,
            Some("inline-right") => InlineRight,
            Some("hidden") => Hidden,
            Some(x) => panic!(
                "Failed to parse {x} as an InfoDisplay. Possible options are `default`, `inline`, `inline-right` or `hidden`"
            ),
        };
        let separator = if display.is_inline() {
            parts.next().or(Some(DEFAULT_SEPARATOR)).map(String::from)
        } else {
            None
        };
        Self { display, separator }
    }
}

#[cfg(test)]
#[cfg_attr(coverage, coverage(off))]
mod tests {
    use super::*;

    #[test]
    fn spinner_char_returns_first_frame_immediately() {
        // No elapsed time → index 0.
        assert_eq!(spinner_char(Instant::now()), SPINNERS_UNICODE[0]);
    }

    #[test]
    fn info_display_is_inline() {
        assert!(InfoDisplay::Inline.is_inline());
        assert!(InfoDisplay::InlineRight.is_inline());
        assert!(!InfoDisplay::Default.is_inline());
        assert!(!InfoDisplay::Hidden.is_inline());
    }

    #[test]
    fn info_from_display_sets_separator_only_when_inline() {
        let inline = Info::from(InfoDisplay::Inline);
        assert_eq!(inline.separator(), Some(DEFAULT_SEPARATOR));

        let right = Info::from(InfoDisplay::InlineRight);
        assert_eq!(right.separator(), Some(DEFAULT_SEPARATOR));

        let default = Info::from(InfoDisplay::Default);
        assert_eq!(default.separator(), None);

        let hidden = Info::from(InfoDisplay::Hidden);
        assert_eq!(hidden.separator(), None);
    }

    #[test]
    fn info_from_str_parses_each_mode() {
        assert_eq!(Info::from("default").display, InfoDisplay::Default);
        assert_eq!(Info::from("inline").display, InfoDisplay::Inline);
        assert_eq!(Info::from("inline-right").display, InfoDisplay::InlineRight);
        assert_eq!(Info::from("hidden").display, InfoDisplay::Hidden);
    }

    #[test]
    fn info_from_str_uses_custom_and_default_separator() {
        // Inline with an explicit separator after the colon.
        assert_eq!(Info::from("inline: | ").separator(), Some(" | "));
        // Inline without a separator falls back to the default.
        assert_eq!(Info::from("inline").separator(), Some(DEFAULT_SEPARATOR));
        // Non-inline modes never carry a separator.
        assert_eq!(Info::from("hidden").separator(), None);
    }

    #[test]
    #[should_panic(expected = "Failed to parse")]
    fn info_from_str_panics_on_unknown_mode() {
        let _ = Info::from("bogus");
    }
}