Struct Text 

pub struct Text {
    pub plain: String,
    pub spans: Vec<Span>,
    pub style: Style,
    pub justify: JustifyMethod,
    pub end: String,
    pub overflow: OverflowMethod,
    pub no_wrap: bool,
    pub tab_size: usize,
    pub indent_guides: bool,
}

A renderable piece of text with optional style spans.

Fields

plain: String

The plain text content.

spans: Vec<Span>

Style spans applied over the text.

style: Style

Default style for the entire text.

justify: JustifyMethod

Justification method.

end: String

End string (appended during rendering).

overflow: OverflowMethod

Overflow method.

no_wrap: bool

If true, don’t wrap.

tab_size: usize

Tab width for expand_tabs (default 8).

indent_guides: bool

Whether to show indent guide lines.

Implementations

impl Text

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

Create a new Text with the given plain content.

pub fn styled(style: Style) -> Self

Create a styled Text with a default style but no content.

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

Parse an ANSI-escaped string into a styled Text.

Extracts SGR (Select Graphic Rendition) codes as style spans and strips all other ANSI escape sequences.

pub fn from_markup(markup: &str) -> Self

Parse a BBCode-like markup string into a styled Text. Delegates to crate::markup::render().

pub fn get_style(&self) -> &Style

Get a reference to the default style.

pub fn get_style_mut(&mut self) -> &mut Style

Get a mutable reference to the default style.

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

Get a reference to the spans slice.

pub fn style(self, style: Style) -> Self

Builder: set the default style.

pub fn justify(self, justify: JustifyMethod) -> Self

Builder: set the justification.

pub fn end(self, end: impl Into<String>) -> Self

Builder: set the end string.

pub fn overflow(self, overflow: OverflowMethod) -> Self

Builder: set overflow method.

pub fn no_wrap(self, value: bool) -> Self

Builder: set no_wrap flag.

pub fn tab_size(self, size: usize) -> Self

Builder: set tab size for expand_tabs.

pub fn with_indent_guides(self, show: bool) -> Self

Builder: show indent guides.

pub fn append(&mut self, text: impl Into<Text>, style: Option<Style>)

Append another Text or string to this one, with an optional style.

pub fn append_tokens(&mut self, tokens: Vec<(String, Style)>)

Append a sequence of (text, style) tokens.

pub fn append_styled(&mut self, text: impl Into<String>, style: Style)

Append a plain string with a style.

pub fn cell_len(&self) -> usize

Get the cell length of the plain text.

pub fn style_at(&self, position: usize) -> Style

Get the style at a given position, combining spans.

pub fn get_style_at_offset(&self, offset: usize) -> Style

Get the combined style at a specific byte offset. Iterates through spans that cover the offset and combines them.

pub fn truncate(&mut self, max_width: usize, overflow: OverflowMethod)

Truncate the text to the given maximum width.

pub fn expand_tabs(&mut self)

Expand tab characters to spaces.

pub fn split_lines(&self) -> Vec<Text>

Split the text into lines.

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

Apply a style to a range of text. Equivalent to Python’s Text.stylize().

pub fn stylize_before(&mut self, style: Style, start: usize, end: Option<usize>)

Like [stylize] but inserts the span at the beginning of the spans list, giving it lower priority than existing spans.

pub fn apply_meta(&mut self, meta: Vec<u8>, spans: &[Span])

Apply metadata to the text at the given spans. Sets the style.meta field on overlapping spans.

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

Highlight all regex matches with the given style. Returns count of matches. Equivalent to Python’s Text.highlight_regex().

pub fn blank_copy(&self) -> Self

Return a new Text with the same style settings but empty content.

pub fn copy_styles(&self) -> Self

Return a copy with only the plain text (no spans, default style).

pub fn detect_indentation(&self) -> (String, usize)

Detect the leading whitespace indentation. Returns (indent_string, indent_count) where indent_count is the number of occurrences of the first indent character.

pub fn divide(&self, offsets: &[usize]) -> Vec<Text>

Split the text at the given byte offsets into multiple pieces, preserving style spans.

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

Apply a style to the entire text by adding a full-length span.

pub fn fit(&self, width: usize) -> Text

Truncate or pad to exactly fit width cells. Uses existing truncate + align methods.

pub fn set_length(&mut self, length: usize)

Pad with spaces or truncate to exact length cells.

pub fn remove_suffix(&mut self, suffix: &str) -> bool

Remove a suffix from the text, returning true if it was present.

pub fn rstrip_end(&mut self, end: &str) -> bool

Remove a trailing end string, returning true if it was present.

pub fn right_crop(&mut self, offset: usize) -> Text

Crop all text beyond offset. Returns the cropped (removed) portion.

pub fn rstrip(&mut self) -> &mut Self

Remove trailing whitespace.

pub fn split(&self) -> Vec<Text>

Split at every character boundary, producing per-character Text pieces.

pub fn wrap(&self, width: usize) -> Vec<Text>

Simple word-wrap: split text into lines, each not exceeding width cells. Returns a Vec<Text>, one per wrapped line. Equivalent to Python’s Text.wrap().

pub fn render(&self) -> String

Render the text, applying styles and returning a styled string.

pub fn markup(&self) -> String

Serialize the text to a BBCode-like markup string. Each span is wrapped in [style]...[/] tags.

pub fn pad(&mut self, count: usize, character: char)

Pad the text on both sides with count copies of character.

pub fn pad_left(&mut self, count: usize, character: char)

Pad the left side only.

pub fn pad_right(&mut self, count: usize, character: char)

Pad the right side only.

pub fn align(&mut self, method: AlignMethod, width: usize)

Align the text within a given width using the specified method.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Text

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.

impl Display for Text

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&str> for Text

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Text

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Text> for TextType

fn from(t: Text) -> Self

Converts to this type from the input type.

impl Renderable for Text

Allows a Text object to be used as a renderable.

fn render(&self, _options: &ConsoleOptions) -> RenderResult

Render this object into a RenderResult using the provided options.

fn measure(&self, _options: &ConsoleOptions) -> Option<Measurement>

Optional width-measurement hook (equivalent to __rich_measure__). Override to provide min/max width constraints for layout.