Enum rhai_autodocs::function::Definition

pub enum Definition {
    Function {
        name: String,
        args: Vec<Arg>,
        return_type: Option<String>,
    },
    Operator {
        name: String,
        arg1: Arg,
        arg2: Arg,
        return_type: Option<String>,
    },
    Get {
        target: Arg,
        index: Arg,
        return_type: Option<String>,
    },
    Set {
        target: Arg,
        index: Arg,
        value: Arg,
    },
    IndexGet {
        target: Arg,
        index: Arg,
        return_type: Option<String>,
    },
    IndexSet {
        target: Arg,
        index: Arg,
        value: Arg,
    },
}

Variants

Function

Fields

name: String

args: Vec<Arg>

return_type: Option<String>

Operator

Fields

name: String

arg1: Arg

arg2: Arg

return_type: Option<String>

Get

Fields

target: Arg

index: Arg

return_type: Option<String>

Set

Fields

target: Arg

index: Arg

value: Arg

IndexGet

Fields

target: Arg

index: Arg

return_type: Option<String>

IndexSet

Fields

target: Arg

index: Arg

value: Arg

Implementations

impl Definition

pub fn new( name: &str, args: &[HashMap<String, String>], return_type: Option<String> ) -> Self

pub fn display(&self) -> String

pub fn type_to_str(&self) -> &'static str

Return the function type of the definition as a string.

pub fn name(&self) -> &str

Get the name of the definition if stored.