Struct docgen::Docgen

source · 
pub struct Docgen<'env> { /* private fields */ }
Expand description

The documentation generator.

Implementations§

source§

impl<'env> Docgen<'env>

source

pub fn new(env: &'env GlobalEnv, options: &'env DocgenOptions) -> Self

Creates a new documentation generator.

source

pub fn gen(self) -> Vec<(String, String)> ⓘ

Generate document contents, returning pairs of output file names and generated contents.

Auto Trait Implementations§

§

impl<'env> !RefUnwindSafe for Docgen<'env>

§

impl<'env> !Send for Docgen<'env>

§

impl<'env> !Sync for Docgen<'env>

§

impl<'env> Unpin for Docgen<'env>

§

impl<'env> !UnwindSafe for Docgen<'env>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V