Skip to main content

CommandRegistry

Struct CommandRegistry 

Source
pub struct CommandRegistry { /* private fields */ }
Expand description

A registry of named commands.

Commands are registered at startup and looked up by name during play. The registry is immutable after construction.

Implementations§

Source§

impl CommandRegistry

Source

pub fn new() -> Self

Creates an empty command registry.

Source

pub fn register(&mut self, command: impl Command + 'static)

Registers a command. Overwrites any existing command with the same name.

Source

pub fn execute(&self, name: &str, args: &CommandArgs, ctx: &dyn Context) -> bool

Executes a command by name with parsed arguments.

Returns true if the command was found and executed.

Source

pub fn commands(&self) -> impl Iterator<Item = &dyn Command>

Returns an iterator over all registered commands.

Source

pub fn get(&self, name: &str) -> Option<&dyn Command>

Looks up a command by name.

Source

pub fn len(&self) -> usize

Returns the number of registered commands.

Source

pub fn is_empty(&self) -> bool

Returns true if no commands are registered.

Trait Implementations§

Source§

impl Default for CommandRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.