Struct DocTree 

pub struct DocTree { /* private fields */ }

A structure of documentation tree.

The documentation tree is a half result of documentation generation. The documentation tree has two module nodes which are a root modules of signature and a root module of documentation. These modules are used to finally generate a documentation.

Implementations

impl DocTree

pub fn new( sig_root_mod: Arc<RwLock<ModNode<Sig, ()>>>, doc_root_mod: Arc<RwLock<ModNode<String, Option<String>>>>, ) -> Self

Creates a documentation tree.

pub fn sig_root_mod(&self) -> &Arc<RwLock<ModNode<Sig, ()>>>

Returns the root module of signature.

pub fn doc_root_mod(&self) -> &Arc<RwLock<ModNode<String, Option<String>>>>

Returns the root module of documentation.

pub fn read(&self) -> Result<DocTreeReadGuard<'_>>

Locks the reader-writer locks of root modules with shared read access.

Trait Implementations

impl Clone for DocTree

fn clone(&self) -> DocTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocTree

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

Formats the value using the given formatter.