Struct readme_sync::CodemapFiles

pub struct CodemapFiles { /* fields omitted */ }

Storage for codemap and corresponding codemap files.

Implementations

impl CodemapFiles

pub fn new() -> Self

Creates a new codemap files storage.

pub fn codemap(&self) -> &CodeMap

Returns codemap.

pub fn files(&self) -> &HashMap<Arc<File>, Arc<File>>

Returns readme and documentation files.

pub fn file_docs(&self) -> &HashMap<Arc<FileDocs>, Arc<File>>

Returns parsed documentation collection.

pub fn get_or_insert_codemap_file(&mut self, file: &Arc<File>) -> &Arc<File>

Inserts the given file into the storage if it is not present, then returns a reference to the appropriate file from codemap.

pub fn get_or_insert_codemap_docs_file(
    &mut self,
    file_docs: &Arc<FileDocs>
) -> &Arc<File>

Inserts the given documentation into the storage if it is not present, then returns a reference to the appropriate file from codemap.

Trait Implementations

impl Debug for CodemapFiles

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

Formats the value using the given formatter.

impl Default for CodemapFiles

fn default() -> CodemapFiles

Returns the “default value” for a type.