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,
}

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.

Implementations

impl Text

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

Create a new Text with the given plain content.

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

Create a styled Text.

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 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_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 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 render(&self) -> String

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

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.

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 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 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().

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 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.