Struct CallableMetadata

pub struct CallableMetadata { /* private fields */ }

Representation of a callable’s metadata.

The callable is expected to hold onto an instance of this object within its struct to make queries fast.

Implementations

impl CallableMetadata

pub fn name(&self) -> &str

Gets the callable’s name, all in uppercase.

pub fn return_type(&self) -> Option<ExprType>

Gets the callable’s return type.

pub fn syntax(&self) -> &str

Gets the callable’s syntax specification.

pub fn category(&self) -> &'static str

Gets the callable’s category as a collection of lines. The first line is the title of the category, and any extra lines are additional information for it.

pub fn description(&self) -> Lines<'static>

Gets the callable’s textual description as a collection of lines. The first line is the summary of the callable’s purpose.

pub fn is_argless(&self) -> bool

Returns true if this is a callable that takes no arguments.

pub fn is_function(&self) -> bool

Returns true if this callable is a function (not a command).

Trait Implementations

impl Clone for CallableMetadata

fn clone(&self) -> CallableMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CallableMetadata

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

Formats the value using the given formatter.