Struct FuncMetadata 

#[non_exhaustive]
pub struct FuncMetadata {
    pub hash: u64,
    pub namespace: FnNamespace,
    pub access: FnAccess,
    pub name: Identifier,
    pub num_params: usize,
    pub param_types: FnArgsVec<TypeId>,
    pub params_info: FnArgsVec<Identifier>,
    pub return_type: Identifier,
    pub comments: StaticVec<SmartString<LazyCompact>>,
}

(internals) A type containing the metadata of a single registered function. Exported under the internals features only.

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.

hash: u64

Hash value.

namespace: FnNamespace

Function namespace.

access: FnAccess

Function access mode.

name: Identifier

Function name.

num_params: usize

Number of parameters.

param_types: FnArgsVec<TypeId>

Parameter types (if applicable).

params_info: FnArgsVec<Identifier>

Parameter names and types (if available). Exported under the metadata feature only.

return_type: Identifier

Return type name. Exported under the metadata feature only.

comments: StaticVec<SmartString<LazyCompact>>

Comments. Exported under the metadata feature only.

Implementations

impl FuncMetadata

pub fn gen_signature<'a>( &'a self, type_mapper: impl Fn(&'a str) -> Cow<'a, str>, ) -> String

(metadata) Generate a signature of the function. Exported under the metadata feature only.

Trait Implementations

impl Clone for FuncMetadata

fn clone(&self) -> FuncMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FuncMetadata

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

Formats the value using the given formatter.

impl Hash for FuncMetadata

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 PartialEq for FuncMetadata

fn eq(&self, other: &FuncMetadata) -> 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 Eq for FuncMetadata

impl StructuralPartialEq for FuncMetadata