Enum Item 

pub enum Item {
    Function {
        root_metadata: Metadata,
        metadata: Vec<Metadata>,
        name: String,
        index: usize,
    },
    CustomType {
        metadata: Metadata,
        index: usize,
    },
}

Generic representation of documentation for a specific item. (a function, a custom type, etc.)

Variants

Function

Fields

root_metadata: Metadata

metadata: Vec<Metadata>

name: String

index: usize

CustomType

Fields

metadata: Metadata

index: usize

Implementations

impl Item

pub const fn index(&self) -> usize

Get the index of the item, extracted from the # rhai-autodocs:index directive.

pub fn name(&self) -> &str

Get the name of the item.

pub fn heading_id(&self) -> String

Generate a heading id for mardown, using the type and name of the item.

Trait Implementations

impl Clone for Item

fn clone(&self) -> Item

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Item

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for Item

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.