Struct Signature 

#[non_exhaustive]
pub struct Signature {
    pub text: String,
    pub params: Vec<SignatureParam>,
    pub required_params: usize,
    pub variadic: bool,
    pub return_type: Option<String>,
    pub domains: Vec<SignatureDomain>,
}

A compact signature for a catalog action or value.

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.

text: String

The signature rendered in the requested locale’s call syntax: parameters appear in call order, a parameter without a declared default reads name: Type, a parameter with a declared default reads name=default or name? when the default is null, and an enum-typed parameter without a default reads name: Domain(members) listing the domain’s members once per signature when it has at most 32 members, or name: Domain(count members) for a larger domain.

params: Vec<SignatureParam>

Parameters in call order.

required_params: usize

The argument count a call must supply: positions below this index cannot be omitted; declared defaults only make the suffix optional.

variadic: bool

Whether the final parameter repeats for extra arguments.

return_type: Option<String>

The source-backed return type for values, when declared.

domains: Vec<SignatureDomain>

The enum domains referenced by parameters, each with the members it accepts, for follow-up inspection of large domains.

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

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

Formats the value using the given formatter.

impl PartialEq for Signature

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Signature