richrs 0.2.1

A Rust port of the Rich Python library for beautiful terminal output
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

//! # richrs - Beautiful Terminal Output for Rust
//!
//! `richrs` is a Rust port of the [Rich](https://github.com/Textualize/rich) Python library,
//! providing beautiful terminal output with colors, styles, tables, progress bars, and more.
//!
//! ## Features
//!
//! - **Console**: The main interface for terminal output with markup support
//! - **Style**: Define text styles with colors and attributes
//! - **Text**: Rich text objects with inline styling
//! - **Table**: Beautiful data tables with borders and alignment
//! - **Panel**: Boxed content with titles and subtitles
//! - **Progress**: Progress bars with multiple concurrent tasks
//! - **Tree**: Hierarchical data visualization
//! - **Markup**: Console markup syntax for inline styling
//!
//! ## Quick Start
//!
//! ```rust,ignore
//! use richrs::prelude::*;
//!
//! let console = Console::new();
//! console.print("[bold red]Hello[/] [green]World![/]")?;
//! ```
//!
//! ## Compatibility
//!
//! This library provides compatible markup syntax and styling with Python Rich.
//! The API is designed to feel Rust-native while supporting the same features.

#![doc(html_root_url = "https://docs.rs/richrs/0.2.1")]

// Re-export core types
pub mod align;
pub mod color;
pub mod columns;
pub mod console;
pub mod emoji;
pub mod errors;
pub mod highlighter;
pub mod live;
pub mod markdown;
pub mod markup;
pub mod panel;
pub mod pretty;
pub mod progress;
pub mod prompt;
pub mod rule;
pub mod spinner;
pub mod status;
pub mod style;
pub mod syntax;
pub mod table;
pub mod text;
pub mod tree;

// Internal modules - hidden from public documentation
#[doc(hidden)]
pub mod box_chars;
#[doc(hidden)]
pub mod measure;
#[doc(hidden)]
pub mod padding;
#[doc(hidden)]
pub mod protocol;
#[doc(hidden)]
pub mod segment;

/// Prelude module for convenient imports.
///
/// # Example
///
/// ```rust,ignore
/// use richrs::prelude::*;
/// ```
pub mod prelude {

    pub use crate::align::Align;
    pub use crate::color::Color;
    pub use crate::columns::{ColumnAlign, Columns};
    pub use crate::console::{Console, ConsoleOptions, Justify, Overflow};
    pub use crate::emoji::Emoji;
    pub use crate::errors::{Error, Result};
    pub use crate::highlighter::{
        Highlighter, ISOHighlighter, JSONHighlighter, RegexHighlighter, ReprHighlighter,
    };
    pub use crate::live::Live;
    pub use crate::markdown::Markdown;
    pub use crate::markup::Markup;
    pub use crate::panel::Panel;
    pub use crate::pretty::{Pretty, inspect, inspect_with_options};
    pub use crate::progress::{Progress, ProgressBar, Task};
    pub use crate::prompt::{Confirm, FloatPrompt, IntPrompt, Prompt};
    pub use crate::rule::Rule;
    pub use crate::segment::Segment;
    pub use crate::spinner::Spinner;
    pub use crate::status::Status;
    pub use crate::style::Style;
    pub use crate::syntax::Syntax;
    pub use crate::table::{Column, Table};
    pub use crate::text::Text;
    pub use crate::tree::{Tree, TreeNode};
}