Skip to main content

DocIterator

Trait DocIterator 

Source
pub trait DocIterator: Iterator {
    // Required method
    fn take_doc(&mut self) -> Option<String>;
}
Expand description

A trait of documentation iterator.

A documenentation iterator is a normal iterator with a documentation collection. A parser collects documentation by this interator and then documentation is stored in a documentation module

Required Methods§

Source

fn take_doc(&mut self) -> Option<String>

Takes the documentation.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§