tty-interface 3.0.0

Provides simple TTY-based interface capabilities including partial re-renders of multi-line displays.
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

use crate::mode::{CursorMode, RenderMode};

/// Options for an interface's behavior.
pub struct Configuration {
    cursor_mode: CursorMode,
    render_mode: RenderMode,
}

impl Configuration {
    /// Create a new, immutable configuration.
    pub fn new(cursor_mode: CursorMode, render_mode: RenderMode) -> Self {
        Self {
            cursor_mode,
            render_mode,
        }
    }

    /// This configuration's cursor movement mode.
    pub fn cursor_mode(&self) -> CursorMode {
        self.cursor_mode
    }

    /// This configuration's terminal rendering mode.
    pub fn render_mode(&self) -> RenderMode {
        self.render_mode
    }
}

impl Default for Configuration {
    fn default() -> Self {
        Self {
            cursor_mode: CursorMode::default(),
            render_mode: RenderMode::default(),
        }
    }
}