ModuleGenerator

Struct ModuleGenerator 

Source
pub struct ModuleGenerator<'a> {
    pub prefix_path: String,
    pub module_file_name: &'a str,
    pub root_item: &'a Item,
    pub index: &'a Index,
    pub paths: &'a Paths,
    pub external_crate: &'a ExternalCrates,
}

Fields§

§prefix_path: String§module_file_name: &'a str§root_item: &'a Item§index: &'a Index§paths: &'a Paths§external_crate: &'a ExternalCrates

Implementations§

Source§

impl<'a> ModuleGenerator<'a>

Source

pub fn new( prefix_path: String, module_file_name: &'a str, root_item: &'a Item, index: &'a Index, paths: &'a Paths, external_crate: &'a ExternalCrates, ) -> Self

Source

pub fn auto(self) -> Result<()>

Source

pub fn generate_module_docs(module_information: &ModuleItems<'_>) -> String

Auto Trait Implementations§

§

impl<'a> Freeze for ModuleGenerator<'a>

§

impl<'a> RefUnwindSafe for ModuleGenerator<'a>

§

impl<'a> Send for ModuleGenerator<'a>

§

impl<'a> Sync for ModuleGenerator<'a>

§

impl<'a> Unpin for ModuleGenerator<'a>

§

impl<'a> UnwindSafe for ModuleGenerator<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.