Struct rhai::ScriptFnMetadata
source · #[non_exhaustive]pub struct ScriptFnMetadata<'a> {
pub name: &'a str,
pub params: Vec<&'a str>,
pub access: FnAccess,
pub this_type: Option<&'a str>,
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.
this_type: Option<&'a str>
Type of this
pointer, if any.
Not available under no_object
.
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<'de: 'a, 'a> Deserialize<'de> for ScriptFnMetadata<'a>
impl<'de: 'a, 'a> Deserialize<'de> for ScriptFnMetadata<'a>
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl Display for ScriptFnMetadata<'_>
impl Display for ScriptFnMetadata<'_>
source§impl<'a> From<&'a ScriptFuncDef> for ScriptFnMetadata<'a>
impl<'a> From<&'a ScriptFuncDef> for ScriptFnMetadata<'a>
source§fn from(value: &'a ScriptFuncDef) -> Self
fn from(value: &'a ScriptFuncDef) -> 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 for ScriptFnMetadata<'a>
impl<'a> PartialEq 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 for ScriptFnMetadata<'a>
impl<'a> PartialOrd 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 moresource§impl<'a> Serialize for ScriptFnMetadata<'a>
impl<'a> Serialize for ScriptFnMetadata<'a>
impl<'a> Eq for ScriptFnMetadata<'a>
impl<'a> StructuralPartialEq for ScriptFnMetadata<'a>
Auto Trait Implementations§
impl<'a> Freeze for ScriptFnMetadata<'a>
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Variant for T
impl<T> Variant for T
source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Variant
trait object to &mut dyn Any
.source§fn as_boxed_any(self: Box<T>) -> Box<dyn Any>
fn as_boxed_any(self: Box<T>) -> Box<dyn Any>
Variant
trait object to Box<dyn Any>
.