Struct minimad::Composite

pub struct Composite<'a> {
    pub style: CompositeStyle,
    pub compounds: Vec<Compound<'a>>,
}

a composite is a monoline sequence of compounds. It’s defined by

• the global style of the composite, if any
• a vector of styled parts

Fields

style: CompositeStyle

compounds: Vec<Compound<'a>>

Implementations

impl<'a> Composite<'a>

pub fn new() -> Composite<'a>

pub fn from_inline(md: &'a str) -> Composite<'a>

parse a monoline markdown snippet which isn’t from a text.

pub fn is_code(&self) -> bool

pub fn is_list_item(&self) -> bool

pub fn is_quote(&self) -> bool

pub fn char_length(&self) -> usize

return the total number of characters in the composite

Example

assert_eq!(minimad::Line::from("τ:`2π`").char_length(), 4);

This may not be the visible width: a renderer can add some things (maybe some caracters) to wrap inline code, or a bullet in front of a list item

pub fn trim_start_spaces(&mut self)

remove all white spaces at left, unless in inline code Empty compounds are cleaned out

pub fn trim_end_spaces(&mut self)

remove all white spaces at right, unless in inline code Empty compounds are cleaned out

pub fn trim_spaces(&mut self)

pub fn is_empty(&self) -> bool

pub fn remove_chars_left(&mut self, to_remove: usize)

remove characters, and whole compounds if necessary

pub fn remove_chars_right(&mut self, to_remove: usize)

remove characters, and whole compounds if necessary

pub fn remove_chars(&mut self, to_remove: usize, align: Alignment)

remove characters, and whole compounds if necessary.

align is the alignment of the composite. If the composite is left aligned, we remove chars at the right.

Trait Implementations

impl<'a> Clone for Composite<'a>

fn clone(&self) -> Composite<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Composite<'a>

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

Formats the value using the given formatter.

impl Default for Composite<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<Vec<Compound<'a>, Global>> for Composite<'a>

fn from(compounds: Vec<Compound<'a>>) -> Composite<'a>

Converts to this type from the input type.

impl<'a> PartialEq<Composite<'a>> for Composite<'a>

fn eq(&self, other: &Composite<'a>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for Composite<'a>

impl<'a> StructuralEq for Composite<'a>

impl<'a> StructuralPartialEq for Composite<'a>