Struct rhai::ScriptFuncDef

pub struct ScriptFuncDef {
    pub body: StmtBlock,
    pub name: ImmutableString,
    pub access: FnAccess,
    pub this_type: Option<ImmutableString>,
    pub params: FnArgsVec<ImmutableString>,
    pub comments: StaticVec<SmartString<LazyCompact>>,
}

(internals) A type containing information on a script-defined function. Exported under the internals feature only.

Fields

body: StmtBlock

Function body.

name: ImmutableString

Function name.

access: FnAccess

Function access mode.

this_type: Option<ImmutableString>

Type of this pointer, if any. Not available under no_object.

params: FnArgsVec<ImmutableString>

Names of function parameters.

comments: StaticVec<SmartString<LazyCompact>>

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

Doc-comments are comment lines beginning with /// or comment blocks beginning with /**, placed immediately before a function definition.

Block doc-comments are kept in a single string with line-breaks within.

Line doc-comments are merged, with line-breaks, into a single string without a termination line-break.

Leading white-spaces are stripped, and each string always starts with the corresponding doc-comment leader: /// or /**.

Each line in non-block doc-comments starts with ///.

Trait Implementations

impl Clone for ScriptFuncDef

fn clone(&self) -> ScriptFuncDef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptFuncDef

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

Formats the value using the given formatter.

impl Display for ScriptFuncDef

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

Formats the value using the given formatter.

impl<'a> From<&'a ScriptFuncDef> for ScriptFnMetadata<'a>

fn from(value: &'a ScriptFuncDef) -> Self

Converts to this type from the input type.

impl From<ScriptFuncDef> for RhaiFunc

fn from(fn_def: ScriptFuncDef) -> Self

Converts to this type from the input type.