Struct ornament::Decorator

pub struct Decorator<F: Default> { /* fields omitted */ }

A helper type to build a Text instance.

It can be used in several manners.

• Incremental, using a "current face" (*_face and append methods).
• Immediate by setting face ranges directly (set method).
• A combination of both.

Implementations

impl<F> Decorator<F> where
    F: Clone + Default + PartialEq, 

pub fn new() -> Decorator<F>

Creates a new empty Decorator.

pub fn with_text(text: &str) -> Decorator<F>

Creates a new Decorator initialized with text.

pub fn current_face(&self) -> &F

Returns the current face. On init this value will be equivalent to F::default().

This face is mostly used by append which will assign the current face to the appended text.

pub fn set_face(&mut self, face: F) -> &mut Self

Sets the current face.

This method is chainable.

pub fn reset_face(&mut self) -> &mut Self

Resets the current face. This is equivalent to calling set_face with F::default().

This method is chainable.

pub fn append(&mut self, text: &str) -> &mut Self

Appends text to the buffer and assigns it the current face.

This method is chainable.

pub fn set(&mut self, face: F, range: Range<usize>) -> &mut Self

Assigns face to the given range. It overrides all faces previously assigned to this range.

This method is chainable.

pub fn build(&mut self) -> Text<F>

Processes all face assignations and returns the corresponding Text.

Trait Implementations

impl<F> Default for Decorator<F> where
    F: Clone + Default + PartialEq, 

fn default() -> Self

Returns the "default value" for a type.