Struct CommandHandle

pub struct CommandHandle { /* private fields */ }

A handle to a Command subscription.

Holding the command handle indicates that the command is relevant in the current app state. The handle needs to be enabled to indicate that the command primary action can be executed.

You can use the Command::subscribe method in a command type to create a handle.

Implementations

impl CommandHandle

pub fn command(&self) -> Option<Command>

The command.

pub fn set_enabled(&self, enabled: bool)

Sets if the command event handler is active.

When at least one CommandHandle is enabled the command is is_enabled.

pub fn is_enabled(&self) -> bool

Returns if this handle has enabled the command.

pub fn dummy() -> CommandHandle

New handle not connected to any command.

pub fn is_dummy(&self) -> bool

If the handle is not connected to any command.

Trait Implementations

impl Debug for CommandHandle

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

Formats the value using the given formatter.

impl Default for CommandHandle

fn default() -> CommandHandle

Returns the “default value” for a type.

impl Drop for CommandHandle

fn drop(&mut self)

Executes the destructor for this type.