rhai_autodocs::export

Struct Options

Source 
pub struct Options { /* private fields */ }
Expand description

Options to configure documentation generation.

Implementations§

Source§

impl Options

Source

pub const fn include_standard_packages( self, include_standard_packages: bool, ) -> Self

Include the standard package functions and modules documentation in the generated documentation markdown.

Source

pub const fn order_items_with(self, items_order: ItemsOrder) -> Self

Order documentation items in a specific way. See ItemsOrder for more details.

Source

pub const fn format_sections_with(self, sections_format: SectionFormat) -> Self

Format doc comments ‘sections’, markdown that starts with the # character, with special formats. See SectionFormat for more details.

Source

pub fn export(self, engine: &Engine) -> Result<Documentation, Error>

Generate documentation based on an engine instance. Make sure all the functions, operators, plugins, etc. are registered inside this instance.

§Result
  • A vector of documented modules.
§Errors
  • Failed to generate function metadata as json.
  • Failed to parse module metadata.

Trait Implementations§

Source§

impl Default for Options

Source§

fn default() -> Options

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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.