Struct rhai::ScriptFnDef

pub struct ScriptFnDef {
    pub body: StmtBlock,
    pub lib: Option<Shared<Module>>,
    pub mods: Imports,
    pub name: Identifier,
    pub access: FnAccess,
    pub params: StaticVec<Identifier>,
    pub externals: BTreeSet<Identifier>,
    pub comments: StaticVec<String>,
}

(INTERNALS) A type containing information on a scripted function. Exported under the internals feature only.

Volatile Data Structure

This type is volatile and may change.

Fields

body: StmtBlock

Function body.

lib: Option<Shared<Module>>

Encapsulated running environment, if any.

mods: Imports

Encapsulated imported modules.

Not available under no_module.

name: Identifier

Function name.

access: FnAccess

Function access mode.

params: StaticVec<Identifier>

Names of function parameters.

externals: BTreeSet<Identifier>

Access to external variables.

Not available under no_closure.

comments: StaticVec<String>

(METADATA) Function doc-comments (if any). Exported under the metadata feature only.

Not available under no_function.

Trait Implementations

impl Clone for ScriptFnDef

fn clone(&self) -> ScriptFnDef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptFnDef

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

Formats the value using the given formatter.

impl Display for ScriptFnDef

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

Formats the value using the given formatter.

impl From<ScriptFnDef> for CallableFunction

fn from(_func: ScriptFnDef) -> Self

Performs the conversion.

impl<'a> Into<ScriptFnMetadata<'a>> for &'a ScriptFnDef

fn into(self) -> ScriptFnMetadata<'a>

Performs the conversion.