cursive 0.21.1

A TUI (Text User Interface) library focused on ease-of-use.
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

/// Extension trait for the `Cursive` root to simplify initialization.
///
/// It brings backend-specific methods to initialize a `Cursive` root.
///
/// # Examples
///
/// ```rust,no_run
/// use cursive::{Cursive, CursiveExt};
///
/// let mut siv = Cursive::new();
///
/// // Use `CursiveExt::run()` to pick one of the enabled backends,
/// // depending on cargo features.
/// siv.run();
///
/// // Or explicitly use a specific backend
/// #[cfg(feature = "ncurses-backend")]
/// siv.run_ncurses().unwrap();
/// #[cfg(feature = "panncurses-backend")]
/// siv.run_pancurses().unwrap();
/// #[cfg(feature = "termion-backend")]
/// siv.run_termion().unwrap();
/// #[cfg(feature = "crossterm-backend")]
/// siv.run_crossterm().unwrap();
/// #[cfg(feature = "blt-backend")]
/// siv.run_blt();
/// ```
pub trait CursiveExt {
    /// Tries to use one of the enabled backends.
    ///
    /// Will fallback to the dummy backend if no other backend feature is enabled.
    ///
    /// # Panics
    ///
    /// If the backend initialization fails.
    fn run(&mut self);

    /// Creates a new Cursive root using a ncurses backend.
    #[cfg(feature = "ncurses-backend")]
    #[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "ncurses-backend")))]
    fn run_ncurses(&mut self) -> std::io::Result<()>;

    /// Creates a new Cursive root using a pancurses backend.
    #[cfg(feature = "pancurses-backend")]
    #[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "pancurses-backend")))]
    fn run_pancurses(&mut self) -> std::io::Result<()>;

    /// Creates a new Cursive root using a termion backend.
    #[cfg(feature = "termion-backend")]
    #[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "termion-backend")))]
    fn run_termion(&mut self) -> std::io::Result<()>;

    /// Creates a new Cursive root using a crossterm backend.
    #[cfg(feature = "crossterm-backend")]
    #[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "crossterm-backend")))]
    fn run_crossterm(&mut self) -> Result<(), std::io::Error>;

    /// Creates a new Cursive root using a bear-lib-terminal backend.
    #[cfg(feature = "blt-backend")]
    #[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "blt-backend")))]
    fn run_blt(&mut self);
}

impl CursiveExt for cursive_core::Cursive {
    fn run(&mut self) {
        cfg_if::cfg_if! {
            if #[cfg(feature = "blt-backend")] {
                self.run_blt()
            } else if #[cfg(feature = "termion-backend")] {
                self.run_termion().unwrap()
            } else if #[cfg(feature = "pancurses-backend")] {
                self.run_pancurses().unwrap()
            } else if #[cfg(feature = "ncurses-backend")] {
                self.run_ncurses().unwrap()
            } else if #[cfg(feature = "crossterm-backend")] {
                self.run_crossterm().unwrap()
            } else {
                log::warn!("No built-it backend, falling back to Cursive::dummy().");
                self.run_dummy()
            }
        }
    }

    #[cfg(feature = "ncurses-backend")]
    #[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "curses-backend")))]
    fn run_ncurses(&mut self) -> std::io::Result<()> {
        self.try_run_with(crate::backends::curses::n::Backend::init)
    }

    #[cfg(feature = "pancurses-backend")]
    #[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "pancurses-backend")))]
    fn run_pancurses(&mut self) -> std::io::Result<()> {
        self.try_run_with(crate::backends::curses::pan::Backend::init)
    }

    #[cfg(feature = "termion-backend")]
    #[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "termion-backend")))]
    fn run_termion(&mut self) -> std::io::Result<()> {
        self.try_run_with(crate::backends::termion::Backend::init)
    }

    #[cfg(feature = "crossterm-backend")]
    #[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "crossterm-backend")))]
    fn run_crossterm(&mut self) -> Result<(), std::io::Error> {
        self.try_run_with(crate::backends::crossterm::Backend::init)
    }

    #[cfg(feature = "blt-backend")]
    #[cfg_attr(feature = "doc-cfg", doc(cfg(feature = "blt-backend")))]
    fn run_blt(&mut self) {
        self.run_with(crate::backends::blt::Backend::init)
    }
}