tuyere 0.1.0

A powerful TUI framework based on The Elm Architecture 🔮
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

//! App builder for convenient setup.

use crate::model::Model;
use crate::program::{Program, ProgramOptions};
use std::io;

/// A builder for creating and running Cauldron applications.
///
/// # Example
///
/// ```rust,no_run
/// use cauldron::{App, Model, Command};
///
/// struct MyApp;
///
/// impl Model for MyApp {
///     type Message = ();
///     fn update(&mut self, _: ()) -> Command<()> { Command::quit() }
///     fn view(&self) -> String { "Hello!".into() }
/// }
///
/// App::new(MyApp)
///     .with_mouse()
///     .run()
///     .unwrap();
/// ```
pub struct App<M: Model> {
    model: M,
    options: ProgramOptions,
}

impl<M: Model + 'static> App<M> {
    /// Create a new app with the given model.
    pub fn new(model: M) -> Self {
        Self {
            model,
            options: ProgramOptions::default(),
        }
    }

    /// Enable mouse support.
    #[must_use]
    pub fn with_mouse(mut self) -> Self {
        self.options.mouse = true;
        self
    }

    /// Disable alternate screen (inline mode).
    #[must_use]
    pub fn inline(mut self) -> Self {
        self.options.alternate_screen = false;
        self
    }

    /// Show the cursor.
    #[must_use]
    pub fn show_cursor(mut self) -> Self {
        self.options.hide_cursor = false;
        self
    }

    /// Enable bracketed paste mode.
    #[must_use]
    pub fn with_bracketed_paste(mut self) -> Self {
        self.options.bracketed_paste = true;
        self
    }

    /// Set custom options.
    #[must_use]
    pub fn with_options(mut self, options: ProgramOptions) -> Self {
        self.options = options;
        self
    }

    /// Run the application.
    pub fn run(self) -> io::Result<()> {
        Program::with_options(self.model, self.options).run()
    }
}