Struct Text 

pub struct Text<'a> { /* private fields */ }

A collection of styled text spans.

Text provides a high-level interface for working with styled text. It stores spans (styled text units) and provides operations for:

• Appending and building text
• Applying base styles
• Splitting into lines
• Truncating and wrapping to widths

Ownership

Text supports borrowing via Cow in Span. Use Text<'a> to hold references, or Text<'static> (or just Text if aliased) for owned data.

Implementations

impl<'a> Text<'a>

pub const fn new() -> Self

Create an empty text.

pub fn raw(content: impl Into<Cow<'a, str>>) -> Self

Create text from a raw string (may contain newlines).

pub fn styled(content: impl Into<Cow<'a, str>>, style: Style) -> Self

Create styled text from a string (may contain newlines).

pub fn from_line(line: Line<'a>) -> Self

Create text from a single line.

pub fn from_lines(lines: impl IntoIterator<Item = Line<'a>>) -> Self

Create text from multiple lines.

pub fn from_spans(spans: impl IntoIterator<Item = Span<'a>>) -> Self

Create text from spans (single line).

pub fn from_segments(segments: impl IntoIterator<Item = Segment<'a>>) -> Self

Create text from segments.

pub fn is_empty(&self) -> bool

Check if empty.

pub fn height(&self) -> usize

Get the number of lines.

pub fn height_as_u16(&self) -> u16

Get the number of lines as u16, saturating at u16::MAX.

pub fn width(&self) -> usize

Get the maximum width across all lines.

pub fn measurement(&self) -> TextMeasurement

Return bounds-based measurement for this text block.

pub fn lines(&self) -> &[Line<'a>]

Get the lines.

pub fn style(&self) -> Option<Style>

Get the style of the first span, if any.

Returns None if the text is empty or has no styled spans.

pub fn push_line(&mut self, line: Line<'a>)

Add a line.

pub fn with_line(self, line: Line<'a>) -> Self

Append a line (builder pattern).

pub fn push_span(&mut self, span: Span<'a>)

Add a span to the last line (or create new line if empty).

pub fn with_span(self, span: Span<'a>) -> Self

Append a span to the last line (builder pattern).

pub fn apply_base_style(&mut self, base: Style)

Apply a base style to all lines and spans.

The base style is merged with each span’s style, with the span’s style taking precedence for conflicting properties.

pub fn with_base_style(self, base: Style) -> Self

Create a new Text with base style applied.

pub fn to_plain_text(&self) -> String

Get the plain text content (lines joined with newlines).

pub fn into_segment_lines(self) -> SegmentLines<'a>

Convert to SegmentLines.

pub fn iter(&self) -> impl Iterator<Item = &Line<'a>>

Iterate over lines.

pub fn truncate(&mut self, max_width: usize, ellipsis: Option<&str>)

Truncate all lines to a maximum width.

Lines exceeding max_width are truncated. If ellipsis is provided, it replaces the end of truncated lines.

pub fn truncated(&self, max_width: usize, ellipsis: Option<&str>) -> Self

Create a truncated copy.

Trait Implementations

impl<'a> Clone for Text<'a>

fn clone(&self) -> Text<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Text<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Text<'a>

fn default() -> Text<'a>

Returns the “default value” for a type.

impl<'a> From<&'a str> for Text<'a>

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl<'a> From<Line<'a>> for Text<'a>

fn from(line: Line<'a>) -> Self

Converts to this type from the input type.

impl From<String> for Text<'static>

fn from(s: String) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<Line<'a>> for Text<'a>

fn from_iter<I: IntoIterator<Item = Line<'a>>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> FromIterator<Span<'a>> for Text<'a>

fn from_iter<I: IntoIterator<Item = Span<'a>>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> Hash for Text<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterator for &'a Text<'a>

type Item = &'a Line<'a>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Line<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for Text<'a>

type Item = Line<'a>

The type of the elements being iterated over.

type IntoIter = IntoIter<Line<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> PartialEq for Text<'a>

fn eq(&self, other: &Text<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for Text<'a>

impl<'a> StructuralPartialEq for Text<'a>