Skip to main content

StyledText

Struct StyledText 

Source
pub struct StyledText { /* private fields */ }
Expand description

A sequence of styled spans representing rich text.

Can be constructed from plain &str / String (unstyled), a single Span, or a Vec<Span>.

Layout concatenates all spans before grapheme segmentation. Splitting a grapheme cluster across spans is supported for width and wrapping, but the cluster uses the style active at its first scalar value.

Implementations§

Source§

impl StyledText

Source

pub fn new() -> StyledText

Creates an empty styled text sequence.

Source

pub fn push(&mut self, span: Span)

Appends a styled span to this text sequence.

Source

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

Returns the spans that make up this text sequence.

Source

pub fn spans_mut(&mut self) -> &mut [Span]

Returns mutable access to the spans in this text sequence.

Source

pub fn char_count(&self) -> usize

Total display width in terminal columns.

Wide characters and emoji grapheme clusters count as terminal columns, not Unicode scalar values.

Source

pub fn is_empty(&self) -> bool

Returns true if there is no text content.

Source

pub fn to_cells(&self) -> Vec<Cell>

Converts to a flat sequence of Cells (newlines excluded).

Trait Implementations§

Source§

impl Clone for StyledText

Source§

fn clone(&self) -> StyledText

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StyledText

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StyledText

Source§

fn default() -> StyledText

Returns the “default value” for a type. Read more
Source§

impl Eq for StyledText

Source§

impl From<&str> for StyledText

Source§

fn from(s: &str) -> StyledText

Converts to this type from the input type.
Source§

impl From<Span> for StyledText

Source§

fn from(span: Span) -> StyledText

Converts to this type from the input type.
Source§

impl From<String> for StyledText

Source§

fn from(s: String) -> StyledText

Converts to this type from the input type.
Source§

impl From<StyledText> for StyledBlock

Source§

fn from(text: StyledText) -> StyledBlock

Converts to this type from the input type.
Source§

impl From<Vec<Span>> for StyledText

Source§

fn from(spans: Vec<Span>) -> StyledText

Converts to this type from the input type.
Source§

impl PartialEq for StyledText

Source§

fn eq(&self, other: &StyledText) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for StyledText

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more