Struct Text

Source

pub struct Text {
    pub justify: JustifyMethod,
    pub overflow: OverflowMethod,
    pub no_wrap: bool,
    pub end: String,
    pub tab_size: usize,
    /* private fields */
}

Expand description

Rich text with styled spans.

Text represents styled text where different regions can have different styles. Styles are applied via Span objects which can overlap - when they do, later spans take precedence.

Fields§

§justify: JustifyMethod

Text justification method.

§overflow: OverflowMethod

Overflow handling method.

§no_wrap: bool

Disable wrapping.

§end: String

String to append after text (default “\n”).

§tab_size: usize

Tab expansion size (default 8).

Implementations§

Source §

impl Text

Source

pub fn from_ansi(text: &str) -> Self

Create a Text object from a string containing ANSI escape codes.

Python reference: rich.text.Text.from_ansi + rich.ansi.AnsiDecoder.

Source

pub fn from_ansi_with_options(text: &str, options: &FromAnsiOptions) -> Self

Create a Text object from ANSI escape codes with explicit options.

Source

pub fn new(text: impl Into<String>) -> Self

Create a new Text from plain text.

This does NOT parse Rich markup. If you pass "[bold]text[/]", the literal markup will be preserved in the text. To parse markup into styled spans, use crate::markup::render or crate::markup::render_or_plain and pass the resulting Text.

Source

pub fn styled(text: impl Into<String>, style: Style) -> Self

Create a styled Text.

Source

pub fn assemble(pieces: &[(&str, Option<Style>)]) -> Self

Create Text by assembling multiple styled pieces.

Source

pub fn plain(&self) -> &str

Get the plain text content.

Source

pub fn spans(&self) -> &[Span]

Get the spans.

Source

pub fn len(&self) -> usize

Get the character length.

Source

pub fn is_empty(&self) -> bool

Check if the text is empty.

Source

pub fn cell_len(&self) -> usize

Get the cell width (for terminal display).

Source

pub fn style(&self) -> &Style

Get the base style.

Source

pub fn set_style(&mut self, style: Style)

Set the base style.

Source

pub fn append(&mut self, text: &str)

Append plain text.

Source

pub fn append_styled(&mut self, text: &str, style: Style)

Append styled text.

Source

pub fn append_text(&mut self, other: &Text)

Append another Text object, merging spans.

Source

pub fn stylize(&mut self, start: usize, end: usize, style: Style)

Apply a style to a character range.

Source

pub fn stylize_all(&mut self, style: Style)

Apply style to entire text.

Source

pub fn highlight_regex( &mut self, pattern: &str, style: &Style, ) -> Result<(), Error>

Highlight text matching a pattern with a style.

Source

pub fn highlight_words( &mut self, words: &[&str], style: &Style, case_sensitive: bool, )

Highlight specific words with a style.

Source

pub fn slice(&self, start: usize, end: usize) -> Self

Get a slice of the text as a new Text object.

Source

pub fn join<'a, I>(&self, items: I) -> Self
where I: IntoIterator<Item = &'a Self>,

Join an iterator of Text objects with this text as separator.

Creates a new Text by concatenating all items with this text inserted between each pair. Similar to str::join() but for styled Text.

§Examples

let separator = Text::new(", ");
let items = vec![Text::new("a"), Text::new("b"), Text::new("c")];
let joined = separator.join(&items);
assert_eq!(joined.plain(), "a, b, c");