Struct rhai::ScriptFnMetadata

pub struct ScriptFnMetadata<'a> {
    pub comments: Vec<&'a str>,
    pub access: FnAccess,
    pub name: &'a str,
    pub params: Vec<&'a str>,
}

A type containing the metadata of a script-defined function. Not available under no_function.

Created by AST::iter_functions.

Fields

comments: Vec<&'a str>

Function doc-comments (if any).

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

Line doc-comments are kept in one string slice per line without the termination line-break.

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

access: FnAccess

Function access mode.

name: &'a str

Function name.

params: Vec<&'a str>

Function parameters (if any).

Trait Implementations

impl<'a> Clone for ScriptFnMetadata<'a>

fn clone(&self) -> ScriptFnMetadata<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ScriptFnMetadata<'a>

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

Formats the value using the given formatter.

impl Display for ScriptFnMetadata<'_>

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

Formats the value using the given formatter.

impl<'a> Eq for ScriptFnMetadata<'a>

impl<'a> Hash for ScriptFnMetadata<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

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

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

Performs the conversion.

impl<'a> PartialEq<ScriptFnMetadata<'a>> for ScriptFnMetadata<'a>

fn eq(&self, other: &ScriptFnMetadata<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ScriptFnMetadata<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for ScriptFnMetadata<'a>

impl<'a> StructuralPartialEq for ScriptFnMetadata<'a>