Struct StyledText 

pub struct StyledText { /* private fields */ }

One text flow carrying any number of styles.

The source is stored once. Its private ranges are canonical: they are non-empty, cover the source in order, end only at whole-string grapheme boundaries, and never place equal styles beside each other. Newline and horizontal tab are admitted source controls; layout replaces tabs under this value’s policy, while direct text rendering preserves them.

Implementations

impl StyledText

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

Creates one uniformly styled text flow.

Panics

Panics when text contains a control character other than newline or horizontal tab. Rendered ANSI belongs to the output domain, not this source-text domain.

pub fn try_from_spans<I, S>(spans: I) -> Result<Self, StyledTextError>

where I: IntoIterator<Item = S>, S: Into<TextSpan>,

Joins input segments into one validated, canonical text flow.

Panics

Panics when any segment contains a control character other than newline or horizontal tab.

pub fn as_str(&self) -> &str

Returns the joined plain-text source.

pub fn spans(&self) -> impl Iterator<Item = (&str, &TextStyle)>

Returns the canonical styled segments in source order.

pub fn tab_policy(self, tab_policy: TabPolicy) -> Self

Sets the policy used when this text participates in layout.

Direct text rendering preserves the source tab characters and ignores this layout-only property.

pub fn reset_tab_policy(self) -> Self

Restores the default layout policy of four spaces per tab.

pub const fn get_tab_policy(&self) -> Option<&TabPolicy>

Returns the explicitly configured layout policy, if any.

Trait Implementations

impl Clone for StyledText

fn clone(&self) -> StyledText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StyledText

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

Formats the value using the given formatter.

impl Default for StyledText

fn default() -> StyledText

Returns the “default value” for a type.

impl From<&str> for StyledText

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<String> for StyledText

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<StyledText> for BlockTitle

fn from(text: StyledText) -> Self

Converts to this type from the input type.

impl PartialEq for StyledText

fn eq(&self, other: &StyledText) -> 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 Eq for StyledText

impl StructuralPartialEq for StyledText