rich/
lib.rs

1//! # rich
2//!
3//! A **faithful** Rust port of the Python [`rich`](https://github.com/Textualize/rich)
4//! terminal-rendering library. This crate mirrors upstream module-for-module and
5//! its version tracks the upstream release it reflects (see `UPSTREAM.toml`).
6//!
7//! Local features and the plugin registry live in the separate `rich-ext` crate
8//! — do **not** add non-upstream behavior here. See `AGENTS.md`.
9//!
10//! ## Ported so far (the first vertical slice)
11//!
12//! [`color`] · [`style`] · [`cells`] · [`segment`] · [`markup`] · [`text`] ·
13//! [`theme`] · [`console`] · [`protocol`] (extension points) · [`measure`] ·
14//! [`errors`]
15//!
16//! The remaining modules are tracked as roadmap issues; see `docs/PORTING.md`
17//! for the module map and per-module parity status.
18
19pub mod align;
20pub mod ansi;
21pub mod bar;
22pub mod r#box;
23mod cell_widths;
24pub mod cells;
25pub mod color;
26mod color_names;
27pub mod columns;
28pub mod console;
29pub mod constrain;
30pub mod control;
31pub mod emoji;
32mod emoji_codes;
33pub mod errors;
34pub mod export;
35pub mod filesize;
36pub mod highlighter;
37pub mod json;
38pub mod layout;
39pub mod live;
40pub mod live_render;
41pub mod log_render;
42pub mod markdown;
43pub mod markup;
44pub mod measure;
45pub mod padding;
46pub mod pager;
47pub mod panel;
48pub mod pretty;
49pub mod progress;
50pub mod progress_bar;
51pub mod prompt;
52pub mod protocol;
53pub mod ratio;
54mod repr_patterns;
55pub mod rule;
56pub mod screen;
57pub mod segment;
58pub mod spinner;
59mod spinner_data;
60pub mod status;
61pub mod style;
62pub mod styled;
63pub mod svg;
64pub mod syntax;
65pub mod table;
66pub mod terminal_theme;
67pub mod text;
68pub mod theme;
69pub mod traceback;
70pub mod tree;
71pub mod wrap;
72
73// A small, curated prelude mirroring the most-used names from `rich`'s top level.
74pub use crate::align::{Align, HorizontalAlign};
75pub use crate::ansi::AnsiDecoder;
76pub use crate::bar::Bar;
77pub use crate::color::{Color, ColorSystem, ColorTriplet};
78pub use crate::columns::Columns;
79pub use crate::console::{Console, ConsoleOptions, Justify, Overflow};
80pub use crate::constrain::Constrain;
81pub use crate::control::{Control, ControlType};
82pub use crate::errors::{Result, RichError};
83pub use crate::highlighter::{ISO8601Highlighter, RegexHighlighter, ReprHighlighter};
84pub use crate::json::Json;
85pub use crate::layout::Layout;
86pub use crate::live::{AutoLive, Live};
87pub use crate::live_render::LiveRender;
88pub use crate::log_render::{LogLevel, LogRender};
89pub use crate::padding::Padding;
90pub use crate::pager::{Pager, SystemPager};
91pub use crate::panel::Panel;
92pub use crate::pretty::Pretty;
93pub use crate::progress::{Progress, ProgressColumn};
94pub use crate::progress_bar::ProgressBar;
95pub use crate::protocol::{Highlighter, Renderable};
96pub use crate::rule::Rule;
97pub use crate::screen::Screen;
98pub use crate::segment::Segment;
99pub use crate::spinner::Spinner;
100pub use crate::status::Status;
101pub use crate::style::{Style, StyleType};
102pub use crate::styled::Styled;
103pub use crate::syntax::Syntax;
104pub use crate::table::Table;
105pub use crate::terminal_theme::{
106    TerminalTheme, DEFAULT_TERMINAL_THEME, DIMMED_MONOKAI, MONOKAI, NIGHT_OWLISH, SVG_EXPORT_THEME,
107};
108pub use crate::text::Text;
109pub use crate::theme::Theme;
110pub use crate::traceback::Traceback;
111pub use crate::tree::Tree;
rich/lib.rs

rich/
lib.rs
