r3bl_tui 0.7.2

TUI library to build modern apps inspired by React, Elm, with Flexbox, CSS, editor component, emoji support, and more
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
114
115
116
117
118
119
120
121

/*
 *   Copyright (c) 2024-2025 R3BL LLC
 *   All rights reserved.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

use std::time::Duration;

use strum_macros::AsRefStr;

/// Minimum terminal dimensions required for the TUI to function properly.
/// These values ensure that dialog boxes and other UI elements have sufficient
/// space to render correctly without being truncated or overlapping.
#[repr(u8)]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum MinSize {
    /// Minimum number of columns (width) required for the terminal.
    Col = 65,
    /// Minimum number of rows (height) required for the terminal.
    Row = 11,
}

/// Default buffer sizes used throughout the TUI system.
/// These values provide reasonable defaults for various internal buffers
/// to ensure good performance without excessive memory usage.
#[repr(usize)]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum DefaultSize {
    /// Buffer size for MPSC channels used for inter-thread communication
    /// in the main event loop. This size allows for sufficient message
    /// queuing without blocking senders under normal load.
    MainThreadSignalChannelBufferSize = 1_000,
}

/// Converts `DefaultSize` enum variants to their corresponding usize values.
impl From<DefaultSize> for usize {
    #[allow(clippy::cast_possible_truncation)]
    fn from(default_size: DefaultSize) -> Self { default_size as usize }
}

/// Default timing constants used for telemetry and performance monitoring.
/// These values control how telemetry data is filtered and rate-limited
/// to balance between useful monitoring and system performance.
#[repr(u64)]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum DefaultTiming {
    /// Minimum response time threshold (in microseconds) for telemetry filtering.
    /// Operations faster than this are filtered out to reduce noise in telemetry data.
    TelemetryFilterLowestResponseTimeMinMicros = 100,
    /// Rate limiting threshold (in microseconds) for telemetry reporting.
    /// This prevents telemetry from overwhelming the system during high-frequency operations.
    /// Equivalent to 16 milliseconds, targeting ~60 FPS refresh rate.
    TelemetryRateLimitTimeThresholdMicros = 16_000,
}

/// Converts `DefaultTiming` enum variants to Duration objects.
impl From<DefaultTiming> for Duration {
    #[allow(clippy::cast_possible_truncation)]
    fn from(default_timing: DefaultTiming) -> Self {
        Duration::from_micros(default_timing as u64)
    }
}

/// Unicode box-drawing characters used for rendering dialog borders and UI elements.
/// These characters provide a consistent visual style for drawing rectangular
/// borders, frames, and separators in the terminal user interface.
#[derive(Debug, Eq, PartialEq, AsRefStr)]
pub enum BorderGlyphCharacter {
    /// Top-right corner character: ╮
    #[strum(to_string = "╮")]
    TopRight,

    /// Top-left corner character: ╭
    #[strum(to_string = "╭")]
    TopLeft,

    /// Bottom-right corner character: ╯
    #[strum(to_string = "╯")]
    BottomRight,

    /// Bottom-left corner character: ╰
    #[strum(to_string = "╰")]
    BottomLeft,

    /// Horizontal line character: ─
    #[strum(to_string = "─")]
    Horizontal,

    /// Vertical line character: │
    #[strum(to_string = "│")]
    Vertical,

    /// T-junction pointing left (├ rotated): ┤
    #[strum(to_string = "┤")]
    LineUpDownLeft,

    /// T-junction pointing right: ├
    #[strum(to_string = "├")]
    LineUpDownRight,
}

/// Default character used to represent the cursor in text editing contexts.
/// The medium shade block (▒) provides good visibility while being distinguishable
/// from regular text content.
pub const DEFAULT_CURSOR_CHAR: &str = "▒";

/// Default file extension used for syntax highlighting when the actual file
/// extension cannot be determined. Markdown (.md) is chosen as a reasonable
/// default that provides basic syntax highlighting without being too intrusive.
pub const DEFAULT_SYN_HI_FILE_EXT: &str = "md";