Function terminal_menu::string

source ·
pub fn string<T: Into<String>, T2: Into<String>>(
    name: T,
    default: T2,
    allow_empty: bool
) -> TerminalMenuItem
Expand description

Make a terminal-menu item which you can enter a string of characters to. Empty strings may be enabled with a flag.

Example

use terminal_menu::{menu, string, run, mut_menu};
let menu = menu(vec![
    string("My Strings Name", "Default Value", /* allow empty string */ false)
]);
run(&menu);
println!("My Strings Value: {}", mut_menu(&menu).selection_value("My Strings Name"));
Examples found in repository?
examples/readme.rs (line 10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
fn main() {
    use terminal_menu::{run, menu, label, scroll, list, string, numeric, submenu, back_button};
    let menu = menu(vec![
        label("--------------"),
        label("MY lovely menu!"),
        label("usage: tinker around"),
        label("---------------"),
        scroll("Selection", vec!["First Option", "Second Option", "Third Option"]),
        list("Do Something", vec!["Yes", "No"]),
        string("Your Name", "Samuel", false),
        numeric("Numeric", 5.25, None, None, None),
        submenu("Submenu", vec![back_button("Back")]),
        back_button("Exit"),
    ]);
    run(&menu);
}
More examples
Hide additional examples
examples/string_and_numeric.rs (line 15)
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
fn main() {
    use terminal_menu::{menu, label, button, string, numeric, run, mut_menu};
    let menu = menu(vec![
        label("strings and numerics"),

        // string:
        //  a string of characters
        //  the last arguments specifies if empty strings are allowed

        // empty strings allowed:
        string("ste", "default", true),

        // empty strings not allowed:
        string("stn", "default", false),

        // numeric:
        //  a floating point number
        numeric("num",
            // default
            4.5,

            // step
            Some(1.5),

            // minimum
            None,

            // maximum
            Some(150.0)
        ),

        button("exit")
    ]);
    run(&menu);
    {
        let mm = mut_menu(&menu);
        println!("{}", mm.selection_value("ste"));
        println!("{}", mm.selection_value("stn"));
        println!("{}", mm.numeric_value("num"));
    }
}