Struct DocCodeGetterCollector

pub struct DocCodeGetterCollector<P: TokenStreamGetterCollector> { /* private fields */ }

A generic Getters collector visting documentation.

When parsing Rust code with syn, documentation lines are passed as Attributes, one line at a time. The generic DocCodeGetterCollector allows gathering the documentation code lines together and collecting the Getters using the provided TokenStreamGetterCollector.

Implementations

impl<P: TokenStreamGetterCollector> DocCodeGetterCollector<P>

pub fn new( path: &Path, identification_mode: IdentificationMode, getter_collection: &P::GetterCollection, ) -> Self

Builds a DocCodeGetterCollector.

Getters will be added to the provided GetterCollection. Documentation alias attributes will be discarded.

pub fn have_attribute(&mut self, node: &Attribute)

Analyses the documentation in the provided Attribute.

Note that documentation code is parsed by syn one line at a time, this method will take care of parsing any code found in the provided Attributes and feeding the GetterCollection.

Trait Implementations

impl<P: Debug + TokenStreamGetterCollector> Debug for DocCodeGetterCollector<P>

where P::GetterCollection: Debug,

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

Formats the value using the given formatter.