Command

Enum Command 

Source
pub enum Command<M> {
    None,
    Batch(Vec<Command<M>>),
    Task(Pin<Box<dyn Future<Output = M> + Send>>),
    Navigate {
        route: String,
    },
    SaveState {
        key: String,
    },
    LoadState {
        key: String,
        on_load: fn(Option<Vec<u8>>) -> M,
    },
}
Expand description

Commands for side effects.

Commands represent effects that should happen after a state update:

  • Async tasks (data fetching, file operations)
  • Navigation
  • State persistence

Variants§

§

None

No command

§

Batch(Vec<Command<M>>)

Execute multiple commands

§

Task(Pin<Box<dyn Future<Output = M> + Send>>)

Execute an async task

§

Navigate

Navigate to a route

Fields

§route: String

Route path

§

SaveState

Save state to storage

Fields

§key: String

Storage key

§

LoadState

Load state from storage

Fields

§key: String

Storage key

§on_load: fn(Option<Vec<u8>>) -> M

Callback with loaded state

Implementations§

Source§

impl<M> Command<M>

Source

pub fn task<F>(future: F) -> Command<M>
where F: Future<Output = M> + Send + 'static,

Create a task command from an async block.

Source

pub fn batch(commands: impl IntoIterator<Item = Command<M>>) -> Command<M>

Create a batch of commands.

Source

pub const fn is_none(&self) -> bool

Check if this is the none command.

Source

pub fn map<N, F>(self, f: F) -> Command<N>
where F: Fn(M) -> N + Send + Sync + 'static, M: Send + 'static, N: Send + 'static,

Map the message type using a function.

Trait Implementations§

Source§

impl<M> Default for Command<M>

Source§

fn default() -> Command<M>

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

Auto Trait Implementations§

§

impl<M> Freeze for Command<M>

§

impl<M> !RefUnwindSafe for Command<M>

§

impl<M> Send for Command<M>

§

impl<M> !Sync for Command<M>

§

impl<M> Unpin for Command<M>

§

impl<M> !UnwindSafe for Command<M>

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,