Skip to main content

RichText

Struct RichText 

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

Flat rendered rich text with coalesced styled runs and row metadata.

Implementations§

Source§

impl RichText

Source

pub fn clear(&mut self)

Clears all content while retaining allocated storage.

Source

pub fn rows(&self) -> u16

Returns the number of rendered rows, including a non-empty partial row.

Source

pub fn row_width(&self, row: u16) -> u16

Returns the precomputed terminal-cell width of row.

Source

pub fn row_text(&self, row: u16) -> &str

Returns the plain text in row.

Source

pub fn row_runs( &self, row: u16, ) -> impl DoubleEndedIterator<Item = (Style, &str)> + ExactSizeIterator + Clone + FusedIterator + '_

Iterates the styled runs in row.

Source

pub fn row_soft_wrap(&self, row: u16) -> bool

Whether row soft-wraps onto the following row: it was broken mid-word by width alone, so the pair forms one logical line.

Source

pub fn replay(&self, sink: &mut dyn RichSink)

Replays every row, preserving completed versus trailing partial rows.

Source

pub fn replay_row(&self, row: u16, sink: &mut dyn RichSink)

Replays the runs of one row without appending a newline.

Source

pub fn widest(&self) -> u16

Returns the widest rendered row.

Trait Implementations§

Source§

impl Clone for RichText

Source§

fn clone(&self) -> RichText

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 RichText

Source§

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

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

impl Default for RichText

Source§

fn default() -> RichText

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

impl RichSink for RichText

Source§

fn run(&mut self, style: Style, text: &str)

Appends a styled text run to the current row.
Source§

fn newline(&mut self)

Completes the current row and starts another logical row.
Source§

fn soft_wrap(&mut self)

Completes the current row at a mid-word soft wrap: the text continues on the next row purely because it hit the layout width, with no whitespace collapsed at the break. Read more

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<S> Pipeline for S
where S: RichSink,

Source§

fn clip(self, width: u16, marker: Option<char>) -> Clip<Self>

Hard-clips each row to width, optionally replacing its final cell with a marker.
Source§

fn rows(self, max: u16) -> Rows<Self>

Limits output to at most max rows.
Source§

fn wrap(self, width: u16) -> Wrap<'static, Self>

Word-wraps output without prefixes.
Source§

fn wrap_chars(self, width: u16) -> CharWrap<Self>

Flows output grapheme-exact to width like a bare terminal: every width break is a byte-preserving RichSink::soft_wrap, so joined rows reproduce the source exactly in native copy.
Source§

fn wrap_prefixed<'p>( self, width: u16, first: &'p Prefix, cont: &'p Prefix, ) -> Wrap<'p, Self>

Word-wraps output using first-row and continuation prefixes.
Source§

fn tee(self, copy: &mut RichText) -> Tee<'_, Self>

Copies output into copy while forwarding it.
Source§

fn restyle<F: Fn(Style) -> Style>(self, map: F) -> Restyle<Self, F>

Maps every incoming style.
Source§

fn prefixed<'p>(self, first: &'p Prefix, cont: &'p Prefix) -> Prefixed<'p, Self>

Adds a prefix at the start of every row without wrapping.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.