Struct rhai::ScriptFnMetadata [−][src]
pub struct ScriptFnMetadata<'a> { pub comments: Vec<&'a str>, pub access: FnAccess, pub name: &'a str, pub params: Vec<&'a str>, }
Expand description
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>
(metadata) Function doc-comments (if any).
Exported under the metadata
feature only.
Not available under no_function
.
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
Performs the conversion.
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl<'a> RefUnwindSafe for ScriptFnMetadata<'a>
impl<'a> Send for ScriptFnMetadata<'a>
impl<'a> Sync for ScriptFnMetadata<'a>
impl<'a> Unpin for ScriptFnMetadata<'a>
impl<'a> UnwindSafe for ScriptFnMetadata<'a>
Blanket Implementations
Mutably borrows from an owned value. Read more