pub struct RichText { /* private fields */ }Expand description
Flat rendered rich text with coalesced styled runs and row metadata.
Implementations§
Source§impl RichText
impl RichText
Sourcepub fn rows(&self) -> u16
pub fn rows(&self) -> u16
Returns the number of rendered rows, including a non-empty partial row.
Sourcepub fn row_runs(
&self,
row: u16,
) -> impl DoubleEndedIterator<Item = (Style, &str)> + ExactSizeIterator + Clone + FusedIterator + '_
pub fn row_runs( &self, row: u16, ) -> impl DoubleEndedIterator<Item = (Style, &str)> + ExactSizeIterator + Clone + FusedIterator + '_
Iterates the styled runs in row.
Sourcepub fn row_soft_wrap(&self, row: u16) -> bool
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.
Sourcepub fn replay(&self, sink: &mut dyn RichSink)
pub fn replay(&self, sink: &mut dyn RichSink)
Replays every row, preserving completed versus trailing partial rows.
Sourcepub fn replay_row(&self, row: u16, sink: &mut dyn RichSink)
pub fn replay_row(&self, row: u16, sink: &mut dyn RichSink)
Replays the runs of one row without appending a newline.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for RichText
impl RefUnwindSafe for RichText
impl Send for RichText
impl Sync for RichText
impl Unpin for RichText
impl UnsafeUnpin for RichText
impl UnwindSafe for RichText
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
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>
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)
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)
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
impl<T> DowncastSync for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<S> Pipeline for Swhere
S: RichSink,
impl<S> Pipeline for Swhere
S: RichSink,
Source§fn clip(self, width: u16, marker: Option<char>) -> Clip<Self>
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 wrap_chars(self, width: u16) -> CharWrap<Self>
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>
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>
fn tee(self, copy: &mut RichText) -> Tee<'_, Self>
Copies output into
copy while forwarding it.