Struct fix_getters_utils::collectors::doc_code::DocCodeGetterCollector [−][src]
pub struct DocCodeGetterCollector<P: TokenStreamGetterCollector> { /* fields omitted */ }
Expand description
A generic Getter
s collector visting documentation.
When parsing Rust code with syn
, documentation lines are
passed as Attribute
s, one line at a time.
The generic DocCodeGetterCollector
allows gathering the
documentation code lines together and collecting the
Getter
s using the provided
TokenStreamGetterCollector
.
Implementations
impl<P: TokenStreamGetterCollector> DocCodeGetterCollector<P>
[src]
impl<P: TokenStreamGetterCollector> DocCodeGetterCollector<P>
[src]pub fn new(
path: &Path,
identification_mode: IdentificationMode,
getter_collection: &P::GetterCollection
) -> Self
[src]
pub fn new(
path: &Path,
identification_mode: IdentificationMode,
getter_collection: &P::GetterCollection
) -> Self
[src]Builds a DocCodeGetterCollector
.
Getter
s will be added to the provided GetterCollection
.
Documentation alias attributes will be discarded.
pub fn have_attribute(&mut self, node: &Attribute)
[src]
pub fn have_attribute(&mut self, node: &Attribute)
[src]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
Attribute
s and feeding the GetterCollection
.
Trait Implementations
impl<P: Debug + TokenStreamGetterCollector> Debug for DocCodeGetterCollector<P> where
P::GetterCollection: Debug,
[src]
impl<P: Debug + TokenStreamGetterCollector> Debug for DocCodeGetterCollector<P> where
P::GetterCollection: Debug,
[src]Auto Trait Implementations
impl<P> RefUnwindSafe for DocCodeGetterCollector<P> where
<P as TokenStreamGetterCollector>::GetterCollection: RefUnwindSafe,
<P as TokenStreamGetterCollector>::GetterCollection: RefUnwindSafe,
impl<P> Send for DocCodeGetterCollector<P> where
<P as TokenStreamGetterCollector>::GetterCollection: Send,
<P as TokenStreamGetterCollector>::GetterCollection: Send,
impl<P> Sync for DocCodeGetterCollector<P> where
<P as TokenStreamGetterCollector>::GetterCollection: Sync,
<P as TokenStreamGetterCollector>::GetterCollection: Sync,
impl<P> Unpin for DocCodeGetterCollector<P> where
<P as TokenStreamGetterCollector>::GetterCollection: Unpin,
<P as TokenStreamGetterCollector>::GetterCollection: Unpin,
impl<P> UnwindSafe for DocCodeGetterCollector<P> where
<P as TokenStreamGetterCollector>::GetterCollection: UnwindSafe,
<P as TokenStreamGetterCollector>::GetterCollection: UnwindSafe,