Struct HelpCommand 

pub struct HelpCommand { /* private fields */ }

The HELP command.

Implementations

impl HelpCommand

pub fn new( callables: Rc<RefCell<HashMap<SymbolKey, Rc<CallableMetadata>>>>, console: Rc<RefCell<dyn Console>>, ) -> Rc<Self>

Creates a new command that writes help messages to output.

Trait Implementations

impl Callable for HelpCommand

fn metadata(&self) -> Rc<CallableMetadata>

Returns the metadata for this function.

fn async_exec<'life0, 'life1, 'async_trait>( &'life0 self, scope: Scope<'life1>, ) -> Pin<Box<dyn Future<Output = CallResult<()>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Executes the callable if it is asynchronous.

fn exec(&self, _scope: Scope<'_>) -> Result<(), CallError>

Executes the callable if it is synchronous.