Struct ScriptFnMetadata 

#[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>,
}

A type containing the metadata of a script-defined function.

Not available under no_function.

Created by AST::iter_functions.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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

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

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

Returns a duplicate of the value.

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<'de: 'a, 'a> Deserialize<'de> for ScriptFnMetadata<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ScriptFnMetadata<'_>

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<'a> Hash for ScriptFnMetadata<'a>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for ScriptFnMetadata<'a>

fn cmp(&self, other: &ScriptFnMetadata<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for ScriptFnMetadata<'a>

fn partial_cmp(&self, other: &ScriptFnMetadata<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Serialize for ScriptFnMetadata<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

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