Struct markdown_composer::types::list::List

pub struct List {
    pub items: Vec<ListItem>,
    pub marker: ListItemMarker,
    pub ty: ListType,
}

A markdown list.

Note

The implementation does NOT check if the marker matches the specified list type. It is theoretically possible to create an ordered list that uses dashes as its item markers. The here exposed inner fields should therefore be used with care.

Please use the builders to safely create Markdown compliant documents!

Fields

items: Vec<ListItem>

marker: ListItemMarker

ty: ListType

Implementations

impl List

pub fn builder() -> ListBuilder

impl List

pub fn new() -> Self

Creates a new default List.

The list will be unordered and uses a dash marker.

pub fn ordered() -> Self

Creates a new empty ordered List.

pub fn unordered() -> Self

Creates a new empty unordered List.

pub fn ordered_with(items: Vec<ListItem>) -> Self

Creates a new ordered List with the given items.

pub fn unordered_with(items: Vec<ListItem>) -> Self

Creates a new unordered List with the given items.

Trait Implementations

impl Clone for List

fn clone(&self) -> List

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for List

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

Formats the value using the given formatter.

impl Default for List

fn default() -> List

Returns the "default value" for a type.

impl Display for List

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

Formats the value using the given formatter.