r3bl_tui 0.7.7

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

// Copyright (c) 2025 R3BL LLC. Licensed under Apache License, Version 2.0.

//! Centralized ANSI/VT100 escape sequence constants.
//!
//! This module consolidates all ANSI terminal constants into a single,
//! discoverable location organized by protocol type.
//!
//! ## Organization
//!
//! Constants are grouped by protocol domain:
//! - **[`generic`]**: Terminal modes, DEC modes, mouse tracking, alternate screen
//! - **[`csi`]**: CSI sequences, cursor movement, SGR parameters, color codes
//! - **[`esc`]**: ESC sequences, character set selection, C0 control characters
//! - **[`dsr`]**: Device Status Report response constants
//! - **[`input_sequences`]**: Keyboard input, control characters, mouse protocol markers
//! - **[`mouse`]**: Mouse protocol constants (SGR, X10, RXVT button codes and flags)
//! - **[`raw_mode`]**: Raw mode terminal configuration (VMIN, VTIME)
//! - **[`sgr`]**: SGR byte constants for performance-critical paths
//! - **[`utf8`]**: UTF-8 encoding constants for byte-level text parsing
//!
//! ## Usage
//!
//! ```rust
//! use r3bl_tui::{CSI_START, SGR_RESET_BYTES, ESC_START};
//!
//! // All constants available with flat imports
//! let csi_start = CSI_START;
//! let sgr_reset = SGR_RESET_BYTES;
//! let escape = ESC_START;
//! ```

// Skip rustfmt for rest of file to preserve manual alignment.
// https://stackoverflow.com/a/75910283/2085356
#![cfg_attr(rustfmt, rustfmt_skip)]

// Module is public only when building documentation or tests.
// This allows rustdoc links to work while keeping it private in release builds.
#[cfg(any(test, doc))]
pub mod csi;
#[cfg(not(any(test, doc)))]
mod csi;
#[cfg(any(test, doc))]
pub mod dsr;
#[cfg(not(any(test, doc)))]
mod dsr;
#[cfg(any(test, doc))]
pub mod esc;
#[cfg(not(any(test, doc)))]
mod esc;
#[cfg(any(test, doc))]
pub mod generic;
#[cfg(not(any(test, doc)))]
mod generic;
#[cfg(any(test, doc))]
pub mod input_sequences;
#[cfg(not(any(test, doc)))]
mod input_sequences;
#[cfg(any(test, doc))]
pub mod mouse;
#[cfg(not(any(test, doc)))]
mod mouse;
#[cfg(any(test, doc))]
pub mod raw_mode;
#[cfg(not(any(test, doc)))]
mod raw_mode;
#[cfg(any(test, doc))]
pub mod sgr;
#[cfg(not(any(test, doc)))]
mod sgr;
#[cfg(any(test, doc))]
pub mod utf8;
#[cfg(not(any(test, doc)))]
mod utf8;

// Public re-exports (flat API) for convenience.
pub use csi::*;
pub use dsr::*;
pub use esc::*;
pub use generic::*;
pub use input_sequences::*;
#[allow(unused_imports)]
pub use mouse::*;
pub use raw_mode::*;
pub use sgr::*;
pub use utf8::*;