Struct somedoc::model::block::List

pub struct List { /* fields omitted */ }

A list is either a bulleted or unordered set of values, or an enumerated list of values.

A List is a tree structure with ListItem being the inner nodes in the tree and which may contain either another list, or a Item.

Implementations

impl List

pub fn new(kind: ListKind) -> Self

Create a new list of the provided kind.

pub fn ordered() -> Self

Create a new ordered/numbered item list.

pub fn unordered() -> Self

Create a new unordered/bulleted item list.

pub fn has_inner(&self) -> bool

Returns true if this list contains any items or sub-lists.

pub fn inner(&self) -> &Vec<ListItem>

Return the vector of list items or sub-lists.

pub fn add_item(&mut self, item: Item) -> &mut Self

Add a new item to this list.

pub fn add_item_str(&mut self, item: &str) -> &mut Self

Add a new item to this list.

pub fn add_item_from(&mut self, item: InlineContent) -> &mut Self

Add a new item to this list from the provided content.

pub fn add_sub_list(&mut self, item: List) -> &mut Self

pub fn is_ordered(&self) -> bool

Return true if this is an ordered/numbered item list, else false.

pub fn is_unordered(&self) -> bool

Return true if this is an unordered/bulleted item list, else false.

pub fn kind(&self) -> &ListKind

Return the kind of this list.

Trait Implementations

impl Clone for List

fn clone(&self) -> List

Returns a copy of the value.

pub 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() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for List

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<List> for ListItem

fn from(value: List) -> Self

Performs the conversion.

impl HasLabel for List

fn has_label(&self) -> bool

Returns true if this element has a label, else false.

fn label(&self) -> &Option<Label>

Return the element's label, if present.

fn set_label(&mut self, label: Label) -> &mut Self

Set the current element's label value.

fn unset_label(&mut self) -> &mut Self

Set the current element's label to None.

impl Into<BlockContent> for List

fn into(self) -> BlockContent

Performs the conversion.

impl Serialize for List

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.