Struct termimad::FmtComposite

pub struct FmtComposite<'s> {
    pub kind: CompositeKind,
    pub compounds: Vec<Compound<'s>>,
    pub visible_length: usize,
    pub spacing: Option<Spacing>,
}

Wrap Minimad compounds with their style and termimad specific information

Fields

kind: CompositeKind

compounds: Vec<Compound<'s>>

visible_length: usize

spacing: Option<Spacing>

Implementations

impl<'s> FmtComposite<'s>

pub fn new() -> Self

pub fn from(composite: Composite<'s>, skin: &MadSkin) -> Self

pub fn from_compound(compound: Compound<'s>) -> Self

pub const fn completions(&self) -> (usize, usize)

Return the number of characters (usually spaces) to insert both sides of the composite

pub fn add_compound(&mut self, compound: Compound<'s>)

Add a compound and modifies visible_length accordingly

pub fn recompute_width(&mut self, skin: &MadSkin)

Ensure the cached visible_length is correct.

It’s normally not necessary to call it, but this must be called if compounds are added, removed or modified without using the FmtComposite API

pub fn fit_width(&mut self, width: usize, align: Alignment, skin: &MadSkin)

try to ensure the composite’s width doesn’t exceed the given width.

The alignment can be used, if necessary, to know which side it’s better to remove content (for example if the alignment is left then we remove at right). The fitter may remove a part in the core of the composite if it looks good enough. In this specific case an ellipsis will replace the removed part.

pub fn extend_width(&mut self, width: usize, align: Alignment)

if the composite is smaller than the given width, pad it according to the alignment.

pub fn fill_width(&mut self, width: usize, align: Alignment, skin: &MadSkin)

try to make it so that the composite has exactly the given width, either by shortening it or by adding space.

This calls the fit_width and extend_width methods.

Trait Implementations

impl<'s> Clone for FmtComposite<'s>

fn clone(&self) -> FmtComposite<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> Debug for FmtComposite<'s>

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

Formats the value using the given formatter.

impl Default for FmtComposite<'_>

fn default() -> Self

Returns the “default value” for a type.