Struct user_doc_doc_data::DocDict

pub struct DocDict(pub DocDictTree, pub Vec<(Vec<usize>, String)>);

A dictionary of doc

Tuple Fields

0: DocDictTree

The dictionary tree

1: Vec<(Vec<usize>, String)>

Backlinks and blurbs

Implementations

impl DocDict

pub fn add_entry(
    &mut self,
    documentable: Documentable,
    name_opt: Option<String>,
    number_opt: Option<usize>,
    overwrite_opt: Option<bool>
) -> Result<()>

Add an entry to a documentation dictionary

pub fn add_path(
    &mut self,
    chapter_blurb_opt: &Option<String>,
    name_opt: &Option<String>,
    documentable_opt: Option<Documentable>,
    overwrite_opt: Option<bool>,
    path_names: &[String],
    path_numbers: &[usize]
) -> Result<()>

Add the path specified to a documentation dictionary, filling with empty subtrees to get there. Return Ok(()) on success.

• If the path exists, fail unless overwrite_opt contains true

pub fn deep_iter(
    &self,
    start_slug_opt: Option<Vec<usize>>
) -> IntoIter<(Vec<usize>, &DocDictEntryValueType, usize)>

Produce a depth-first, immutable iterator over the entries.

• The iterator item includes a slug of chapters, the current entry node, and the number of sub entries for the current node The iterator will produce entries for the chapters AS WELL AS entries for the subchapters of those chapters.

pub fn expand_into_mdbook_dirs_at_path(
    &self,
    naming_scheme: DirectoryNamingScheme,
    root_path: &str
) -> Result<()>

Expand this doc dict into directories at the given directory path

pub fn find_next_entry_number(&self) -> usize

Find the next available (unused) entry number in a documentation dictionary

pub fn get_entry_at_numeric_path(
    &self,
    path: &[usize]
) -> Option<&DocDictEntryValueType>

Get an immutable reference to an entry at the specified numeric path. Returns None if the a path is not present.

pub fn get_mut_entry_at_numeric_path(
    &mut self,
    path: &[usize]
) -> Option<&mut DocDictEntryValueType>

Get a mutable reference to an entry at the specified numeric path. Returns None if the a path is not present.

Trait Implementations

impl Clone for DocDict

fn clone(&self) -> DocDict

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocDict

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

Formats the value using the given formatter.

impl Deref for DocDict

type Target = DocDictTree

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for DocDict

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for DocDict

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

Deserialize this value from the given Serde deserializer.

impl Ord for DocDict

fn cmp(&self, other: &DocDict) -> 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<DocDict> for DocDict

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

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

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

This method tests for !=.

impl PartialOrd<DocDict> for DocDict

fn partial_cmp(&self, other: &DocDict) -> 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 DocDict

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 DocDict

impl StructuralEq for DocDict

impl StructuralPartialEq for DocDict