Struct rhai::ScriptFnMetadata
source · #[non_exhaustive]pub struct ScriptFnMetadata<'a> {
pub name: &'a str,
pub params: Vec<&'a str>,
pub access: FnAccess,
pub comments: 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 (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: &'a str
Function name.
params: Vec<&'a str>
Function parameters (if any).
access: FnAccess
Function access mode.
comments: Vec<&'a str>
(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 slice with line-breaks within.
Line doc-comments are merged, with line-breaks, into a single string slice without a termination line-break.
Leading white-spaces are stripped, and each string slice always starts with the
corresponding doc-comment leader: ///
or /**
.
Each line in non-block doc-comments starts with ///
.
Trait Implementations§
source§impl<'a> Clone for ScriptFnMetadata<'a>
impl<'a> Clone for ScriptFnMetadata<'a>
source§fn clone(&self) -> ScriptFnMetadata<'a>
fn clone(&self) -> ScriptFnMetadata<'a>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'a> Debug for ScriptFnMetadata<'a>
impl<'a> Debug for ScriptFnMetadata<'a>
source§impl Display for ScriptFnMetadata<'_>
impl Display for ScriptFnMetadata<'_>
source§impl<'a> From<&'a ScriptFnDef> for ScriptFnMetadata<'a>
impl<'a> From<&'a ScriptFnDef> for ScriptFnMetadata<'a>
source§fn from(value: &'a ScriptFnDef) -> Self
fn from(value: &'a ScriptFnDef) -> Self
source§impl<'a> Hash for ScriptFnMetadata<'a>
impl<'a> Hash for ScriptFnMetadata<'a>
source§impl<'a> Ord for ScriptFnMetadata<'a>
impl<'a> Ord for ScriptFnMetadata<'a>
source§fn cmp(&self, other: &ScriptFnMetadata<'a>) -> Ordering
fn cmp(&self, other: &ScriptFnMetadata<'a>) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl<'a> PartialEq<ScriptFnMetadata<'a>> for ScriptFnMetadata<'a>
impl<'a> PartialEq<ScriptFnMetadata<'a>> for ScriptFnMetadata<'a>
source§fn eq(&self, other: &ScriptFnMetadata<'a>) -> bool
fn eq(&self, other: &ScriptFnMetadata<'a>) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl<'a> PartialOrd<ScriptFnMetadata<'a>> for ScriptFnMetadata<'a>
impl<'a> PartialOrd<ScriptFnMetadata<'a>> for ScriptFnMetadata<'a>
source§fn partial_cmp(&self, other: &ScriptFnMetadata<'a>) -> Option<Ordering>
fn partial_cmp(&self, other: &ScriptFnMetadata<'a>) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more