Skip to main content

Command

Enum Command 

Source
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>),
}
Expand description

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. The boxed closure runs on a background thread and returns a message.

Trait Implementations§

Source§

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

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<Msg> Freeze for Command<Msg>
where Msg: Freeze,

§

impl<Msg> !RefUnwindSafe for Command<Msg>

§

impl<Msg> Send for Command<Msg>
where Msg: Send,

§

impl<Msg> !Sync for Command<Msg>

§

impl<Msg> Unpin for Command<Msg>
where Msg: Unpin,

§

impl<Msg> UnsafeUnpin for Command<Msg>
where Msg: UnsafeUnpin,

§

impl<Msg> !UnwindSafe for Command<Msg>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.