Struct Documentation

pub struct Documentation { /* private fields */ }

Collection of all the documentation entries across the project

Implementations

impl Documentation

pub fn new() -> Self

Create a new and empty doc.

pub fn contains_key(&self, key: &ContentOrigin) -> bool

Check if a particular key is contained.

pub fn is_empty(&self) -> bool

Check if the document contains any checkable items.

pub fn iter( &self, ) -> impl Iterator<Item = (&ContentOrigin, &Vec<CheckableChunk>)>

Borrowing iterator across content origins and associated sets of chunks.

pub fn par_iter( &self, ) -> impl ParallelIterator<Item = (&ContentOrigin, &Vec<CheckableChunk>)>

Borrowing iterator across content origins and associated sets of chunks.

pub fn into_par_iter( self, ) -> impl ParallelIterator<Item = (ContentOrigin, Vec<CheckableChunk>)>

Consuming iterator across content origins and associated sets of chunks.

pub fn extend<I, J>(&mut self, other: I)

where I: IntoIterator<Item = (ContentOrigin, Vec<CheckableChunk>), IntoIter = J>, J: Iterator<Item = (ContentOrigin, Vec<CheckableChunk>)>,

Extend self by joining in other Documentations.

pub fn add_inner(&mut self, origin: ContentOrigin, chunks: Vec<CheckableChunk>)

Adds a set of CheckableChunks to the documentation to be checked.

pub fn add_rust( &mut self, origin: ContentOrigin, content: &str, doc_comments: bool, dev_comments: bool, ) -> Result<()>

Adds a rust content str to the documentation.

pub fn add_cargo_manifest_description( &mut self, path: PathBuf, manifest_content: &str, ) -> Result<()>

Adds a content string to the documentation sourced from the description field in a Cargo.toml manifest.

pub fn add_commonmark( &mut self, origin: ContentOrigin, content: &str, ) -> Result<()>

Adds a common mark content str to the documentation.

pub fn get(&self, origin: &ContentOrigin) -> Option<&[CheckableChunk]>

Obtain the set of chunks for a particular origin.

pub fn entry_count(&self) -> usize

Count the number of origins.

pub fn load_from_str( origin: ContentOrigin, content: &str, doc_comments: bool, dev_comments: bool, ) -> Self

Load a document from a single string with a defined origin.

pub fn len(&self) -> usize

Trait Implementations

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Documentation

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

Formats the value using the given formatter.

impl Default for Documentation

fn default() -> Self

Returns the “default value” for a type.

impl IntoIterator for Documentation

type Item = (ContentOrigin, Vec<CheckableChunk>)

The type of the elements being iterated over.

type IntoIter = IntoIter<ContentOrigin, Vec<CheckableChunk>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.