Struct zng::event::AppCommandArgs

pub struct AppCommandArgs {
    pub args: CommandArgs,
    pub handle: Arc<CommandHandle>,
}

Arguments for Command::on_event.

Fields

args: CommandArgs

The command args.

handle: Arc<CommandHandle>

The command handle held by the event handler.

Methods from Deref<Target = CommandArgs>

pub fn param<T>(&self) -> Option<&T>

where T: Any,

Returns a reference to a parameter of T if parameter is set to a value of T.

pub fn enabled_param<T>(&self) -> Option<&T>

where T: Any,

Returns param if is enabled.

pub fn disabled_param<T>(&self) -> Option<&T>

where T: Any,

Returns param if is not enabled.

pub fn handle_enabled<F, R>( &self, local_handle: &CommandHandle, handler: F, ) -> Option<R>

where F: FnOnce(&CommandArgs) -> R,

Call handler if propagation is not stopped and the command and local handler are enabled. Stops propagation after handler is called.

This is the default behavior of commands, when a command has a handler it is relevant in the context, and overwrites lower priority handlers, but if the handler is disabled the command primary action is not run.

Returns the handler result if it was called.

Trait Implementations

impl AnyEventArgs for AppCommandArgs

fn clone_any(&self) -> Box<dyn AnyEventArgs>

Clone the event into a type erased box.

fn as_any(&self) -> &(dyn Any + 'static)

Access to dyn Any methods.

fn timestamp(&self) -> DInstant

Gets the instant this event happened.

fn delivery_list(&self, list: &mut UpdateDeliveryList)

Insert all targets of this event on the UpdateDeliveryList.

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance.

impl Clone for AppCommandArgs

fn clone(&self) -> AppCommandArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppCommandArgs

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

Formats the value using the given formatter.

impl Deref for AppCommandArgs

type Target = CommandArgs

The resulting type after dereferencing.

fn deref(&self) -> &<AppCommandArgs as Deref>::Target

Dereferences the value.

impl EventArgs for AppCommandArgs

fn handle<F, R>(&self, handler: F) -> Option<R>

where F: FnOnce(&Self) -> R,

Calls handler and stops propagation if propagation is still allowed.