Struct ornament::Text

pub struct Text<F>(_);

A decorated text. This is a collection of TextFragment.

Methods

impl<F> Text<F>

pub fn text_len(&self) -> usize

Returns the length of the underlying text, without decorations, in bytes.

pub fn render<G>(&self, decorator: G) -> String where
    G: Fn(&TextFragment<F>) -> String, 

Converts the decorated text into rich text, using decorator to handle the different faces.

pub fn plain(&self) -> String

Converts the decorated text into plain text, stripping all decorations.

impl<F> Text<F>

pub fn iter(&self) -> TextIterator<F>

Returns an iterator over the text.

Trait Implementations

impl<F: Default> Default for Text<F>

fn default() -> Text<F>

Returns the "default value" for a type.

impl<F: Clone> Clone for Text<F>

fn clone(&self) -> Text<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: PartialEq> PartialEq<Text<F>> for Text<F>

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Text<F>) -> bool

This method tests for !=.

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

type Item = &'a TextFragment<F>

The type of the elements being iterated over.

type IntoIter = TextIterator<'a, F>

Which kind of iterator are we turning this into?

fn into_iter(self) -> TextIterator<'a, F>

Creates an iterator from a value.

impl<F> From<Vec<TextFragment<F>>> for Text<F>

fn from(tfs: Vec<TextFragment<F>>) -> Text<F>

Performs the conversion.

impl<F> From<TextFragment<F>> for Text<F>

fn from(tf: TextFragment<F>) -> Text<F>

Performs the conversion.

impl<'_, F: Default> From<&'_ str> for Text<F>

fn from(s: &str) -> Text<F>

Performs the conversion.

impl<F: Default> From<String> for Text<F>

fn from(s: String) -> Text<F>

Performs the conversion.

impl<F: Debug> Debug for Text<F>

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

Formats the value using the given formatter.