Enum Command 

pub enum Command<Msg> {
    None,
    Quit,
    Batch(Vec<Command<Msg>>),
    Message(Msg),
    SetTickRate(Duration),
    ExportOntology,
    AgentAction {
        agent_id: String,
        action: String,
        params: Value,
    },
    Task(Box<dyn FnOnce() -> Msg + Send>),
    TaskWithTimeout {
        task: Box<dyn FnOnce() -> Msg + Send>,
        timeout: Duration,
        on_timeout: Msg,
    },
    TaskCancellable {
        task: Box<dyn FnOnce(CancellationToken) -> Msg + Send>,
        token: CancellationToken,
    },
}

A command returned from Model::update to request side effects.

Variants

None

No operation.

Quit

Quit the application.

Batch(Vec<Command<Msg>>)

Execute multiple commands.

Message(Msg)

Produce a message asynchronously after the current update.

SetTickRate(Duration)

Set the tick interval for animation / periodic updates.

ExportOntology

Request that the agent ontology registry be exported to JSON.

AgentAction

Execute an agent action on a widget identified by agent_id.

Fields

agent_id: String

action: String

params: Value

Task(Box<dyn FnOnce() -> Msg + Send>)

Spawn an asynchronous task that eventually produces a message.

TaskWithTimeout

Spawn an async task with a timeout. If the task doesn’t complete within the given duration, the timeout message is delivered instead.

Fields

task: Box<dyn FnOnce() -> Msg + Send>

timeout: Duration

on_timeout: Msg

TaskCancellable

Spawn a cancellable async task. The closure receives a CancellationToken that it can poll to exit early.

Fields

task: Box<dyn FnOnce(CancellationToken) -> Msg + Send>

token: CancellationToken

Trait Implementations

impl<Msg: Debug> Debug for Command<Msg>

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

Formats the value using the given formatter.