sparcli 0.3.0

Lightweight, cross-platform toolkit for styled CLI output and interactive input widgets
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

//! Interactive input widgets (prompts).
//!
//! Each prompt runs a small event loop over an
//! [`EventSource`](event::EventSource) and redraws in place. Prompts return an
//! [`Outcome`] that is either a submitted value or a cancellation, and never
//! panic on input.

pub mod confirm;
pub mod datepicker;
pub mod editor;
pub mod event;
pub mod guard;
pub mod history;
pub mod line_edit;
pub mod number;
pub mod password;
pub mod select;
pub mod shortcut;
pub mod text;
pub mod textarea;
pub mod validate;

#[cfg(feature = "fuzzy")]
pub mod fuzzy;

pub(crate) mod field;
pub(crate) mod prompt;

/// The result of running an interactive prompt.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Outcome<T> {
    /// The user submitted a value.
    Submitted(T),
    /// The user cancelled (Esc or Ctrl-C).
    Cancelled,
    /// The user pressed a registered shortcut; carries its id.
    Shortcut(i32),
}

impl<T> Outcome<T> {
    /// Returns the submitted value, or `None` otherwise.
    pub fn submitted(self) -> Option<T> {
        match self {
            Outcome::Submitted(value) => Some(value),
            Outcome::Cancelled | Outcome::Shortcut(_) => None,
        }
    }

    /// Returns `true` if the prompt was cancelled.
    pub fn is_cancelled(&self) -> bool {
        matches!(self, Outcome::Cancelled)
    }

    /// Returns the fired shortcut id, if the prompt ended on a shortcut.
    pub fn shortcut_id(&self) -> Option<i32> {
        match self {
            Outcome::Shortcut(id) => Some(*id),
            _ => None,
        }
    }
}