Trait Handler 

pub trait Handler:
    Sync
    + Send
    + AnySync {
    // Required method
    fn handle<'life0, 'life1, 'async_trait>(
        self: Arc<Self>,
        ctx: &'life0 Arc<dyn Context>,
        argv: Vec<String>,
        cmd: &'life1 str,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;

    // Provided methods
    fn verb(&self, _ctx: &Arc<dyn Context>) -> Option<&'static str> { ... }
    fn condition(&self, ctx: &Arc<dyn Context>) -> bool { ... }
    fn help(&self, _ctx: &Arc<dyn Context>) -> &'static str { ... }
    fn dyn_help(&self, _ctx: &Arc<dyn Context>) -> String { ... }
    fn complete<'life0, 'life1, 'life2, 'async_trait>(
        &'life0 self,
        _ctx: &'life1 Arc<dyn Context>,
        _cmd: &'life2 str,
    ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<String>>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait,
             'life2: 'async_trait { ... }
    fn start<'life0, 'async_trait>(
        self: Arc<Self>,
        _ctx: &'life0 Arc<dyn Context>,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
    fn stop<'life0, 'async_trait>(
        self: Arc<Self>,
        _ctx: &'life0 Arc<dyn Context>,
    ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait { ... }
}

A single command handler, identified by a verb, that can be registered with a HandlerCli and invoked when its verb is entered.

Required Methods

fn handle<'life0, 'life1, 'async_trait>( self: Arc<Self>, ctx: &'life0 Arc<dyn Context>, argv: Vec<String>, cmd: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Executes the command with the parsed argument vector and raw command line.

Provided Methods

fn verb(&self, _ctx: &Arc<dyn Context>) -> Option<&'static str>

Returns the command verb this handler responds to, or None to disable it.

fn condition(&self, ctx: &Arc<dyn Context>) -> bool

Returns whether this handler should be registered in the given context.

fn help(&self, _ctx: &Arc<dyn Context>) -> &'static str

Returns static help text describing the command.

fn dyn_help(&self, _ctx: &Arc<dyn Context>) -> String

Returns dynamically generated help text, used when help is empty.

fn complete<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _ctx: &'life1 Arc<dyn Context>, _cmd: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<String>>>> + Send + 'async_trait>>

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

Returns completion candidates for the command’s arguments, if any.

fn start<'life0, 'async_trait>( self: Arc<Self>, _ctx: &'life0 Arc<dyn Context>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Called when the owning HandlerCli starts, allowing setup.

fn stop<'life0, 'async_trait>( self: Arc<Self>, _ctx: &'life0 Arc<dyn Context>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Called when the owning HandlerCli stops, allowing teardown.

Implementations

impl dyn Handler

pub fn is<_T>(&self) -> bool

where _T: Any, Self: Downcast<_T>,

pub fn downcast_ref<_T>(&self) -> Result<&_T, TypeMismatch>

where _T: Any, Self: Downcast<_T>,

pub fn downcast_mut<_T>(&mut self) -> Result<&mut _T, TypeMismatch>

where _T: Any, Self: Downcast<_T>,

pub fn downcast<_T>( self: Box<Self>, ) -> Result<Box<_T>, DowncastError<Box<Self>>>

where _T: Any, Self: Downcast<_T>,

pub fn downcast_rc<_T>( self: Rc<Self>, ) -> Result<Rc<_T>, DowncastError<Rc<Self>>>

where _T: Any, Self: Downcast<_T>,

pub fn downcast_arc<_T>( self: Arc<Self>, ) -> Result<Arc<_T>, DowncastError<Arc<Self>>>

where _T: AnySync, Self: DowncastSync<_T>,

Trait Implementations

impl<_T> Downcast<_T> for dyn Handler

where _T: Any,

fn is_type(&self) -> bool

fn downcast_ref(&self) -> Result<&T, TypeMismatch>

fn downcast_mut(&mut self) -> Result<&mut T, TypeMismatch>

fn downcast(self: Box<Self>) -> Result<Box<T>, DowncastError<Box<Self>>>

fn downcast_rc(self: Rc<Self>) -> Result<Rc<T>, DowncastError<Rc<Self>>>

impl<_T> DowncastSync<_T> for dyn Handler

where _T: AnySync,

fn downcast_arc(self: Arc<Self>) -> Result<Arc<T>, DowncastError<Arc<Self>>>

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors