Command

Struct Command 

Source
pub struct Command<M> { /* private fields */ }
Expand description

A command that can be returned from update.

Commands represent side effects that should happen after updating the model.

Implementations§

Source§

impl<M> Command<M>

Source

pub fn none() -> Self

Create a command that does nothing.

Source

pub fn quit() -> Self

Create a command that quits the application.

Source

pub fn message(msg: M) -> Self

Create a command that sends a message.

Source

pub fn batch(commands: Vec<Command<M>>) -> Self

Batch multiple commands together.

Source

pub fn perform<F, Fut>(task: F) -> Self
where F: FnOnce() -> Fut, Fut: Future<Output = M> + Send + 'static, M: Send + 'static,

Create a command from an async task.

The task will be spawned and its result will be sent as a message.

Source

pub fn is_quit(&self) -> bool

Check if this is a quit command.

Source

pub fn is_none(&self) -> bool

Check if this is a no-op command.

Trait Implementations§

Source§

impl<M> Default for Command<M>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

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

§

impl<M> !RefUnwindSafe for Command<M>

§

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

§

impl<M> !Sync for Command<M>

§

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

§

impl<M> !UnwindSafe for Command<M>

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.