Enum user_doc_doc_data::Documentable

pub enum Documentable {
    Doc(String, String),
    BoxedDocDict(String, Box<DocDict>),
}

A documentation or a Docdict Each documentable has a name string

Variants

Doc(String, String)

Tuple Fields of Doc

0: String1: String

BoxedDocDict(String, Box<DocDict>)

Tuple Fields of BoxedDocDict

0: String1: Box<DocDict>

Implementations

impl Documentable

pub fn get_inner_boxed_doc_dict_mut_ref(&mut self) -> Option<&mut Box<DocDict>>

Get a mutable reference to the inner chapter (BoxedDocDict) contained if any

pub fn name(&self) -> String

Get this item’s name

pub fn to_string(
    &self,
    header_level: HeaderLevel,
    chapter_nums_opt: Option<Vec<usize>>
) -> String

Coerce this documentation to a string of markdown

Trait Implementations

impl Clone for Documentable

fn clone(&self) -> Documentable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Documentable

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Documentable

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

Deserialize this value from the given Serde deserializer.

impl Display for Documentable

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

Formats the value using the given formatter.

impl Ord for Documentable

fn cmp(&self, other: &Documentable) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<&'_ str> for Documentable

fn eq(&self, rhs: &&str) -> 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 !=.

impl PartialEq<Documentable> for Documentable

fn eq(&self, other: &Documentable) -> bool

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

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

This method tests for !=.

impl PartialOrd<Documentable> for Documentable

fn partial_cmp(&self, other: &Documentable) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Documentable

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

Serialize this value into the given Serde serializer.

impl Eq for Documentable

impl StructuralEq for Documentable

impl StructuralPartialEq for Documentable