DispatchResult

Struct DispatchResult 

Source
pub struct DispatchResult<E> {
    pub changed: bool,
    pub effects: Vec<E>,
}
Expand description

Result of dispatching an action to an effect-aware store.

Contains both the state change indicator and any effects to be processed.

Fields§

§changed: bool

Whether the state was modified by this action.

§effects: Vec<E>

Effects to be processed after dispatch.

Implementations§

Source§

impl<E> DispatchResult<E>

Source

pub fn unchanged() -> Self

Create a result indicating no state change and no effects.

Source

pub fn changed() -> Self

Create a result indicating state changed but no effects.

Source

pub fn effect(effect: E) -> Self

Create a result with a single effect but no state change.

Source

pub fn effects(effects: Vec<E>) -> Self

Create a result with multiple effects but no state change.

Source

pub fn changed_with(effect: E) -> Self

Create a result indicating state changed with a single effect.

Source

pub fn changed_with_many(effects: Vec<E>) -> Self

Create a result indicating state changed with multiple effects.

Source

pub fn with(self, effect: E) -> Self

Add an effect to this result.

Source

pub fn mark_changed(self) -> Self

Set the changed flag to true.

Source

pub fn has_effects(&self) -> bool

Returns true if there are any effects to process.

Trait Implementations§

Source§

impl<E: Clone> Clone for DispatchResult<E>

Source§

fn clone(&self) -> DispatchResult<E>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<E: Debug> Debug for DispatchResult<E>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<E> Default for DispatchResult<E>

Source§

fn default() -> Self

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

impl<E: PartialEq> PartialEq for DispatchResult<E>

Source§

fn eq(&self, other: &DispatchResult<E>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<E: Eq> Eq for DispatchResult<E>

Source§

impl<E> StructuralPartialEq for DispatchResult<E>

Auto Trait Implementations§

§

impl<E> Freeze for DispatchResult<E>

§

impl<E> RefUnwindSafe for DispatchResult<E>
where E: RefUnwindSafe,

§

impl<E> Send for DispatchResult<E>
where E: Send,

§

impl<E> Sync for DispatchResult<E>
where E: Sync,

§

impl<E> Unpin for DispatchResult<E>
where E: Unpin,

§

impl<E> UnwindSafe for DispatchResult<E>
where E: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more