Struct rhai_autodocs::function::FunctionMetadata

pub struct FunctionMetadata {
    pub access: String,
    pub base_hash: u128,
    pub full_hash: u128,
    pub name: String,
    pub namespace: String,
    pub num_params: usize,
    pub params: Option<Vec<HashMap<String, String>>>,
    pub signature: String,
    pub return_type: Option<String>,
    pub doc_comments: Option<Vec<String>>,
}

Metadata exposed by Rhai for functions.

Fields

access: String

base_hash: u128

full_hash: u128

name: String

namespace: String

num_params: usize

params: Option<Vec<HashMap<String, String>>>

signature: String

return_type: Option<String>

doc_comments: Option<Vec<String>>

Implementations

impl FunctionMetadata

pub fn generate_function_definition(&self) -> Definition

Generate a pseudo-Rust definition of a rhai function. e.g. fn my_func(a: int) -> ()

Trait Implementations

impl Clone for FunctionMetadata

fn clone(&self) -> FunctionMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FunctionMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.