pub struct AtomicState<T>(T)
where
    T: Serialize + DeserializeOwned + PartialEq + Clone;
Expand description

Atomic state is a SessionState which holds exactly one value of a generic type T.

The generic type T needs to implement Serialize and DeserializeOwned to make it serializable into the Event payload. Furthermore, we need PartialEq to check if the value changed, and Clone to enable state replication.

Each AtomicState only consumes one type of event: the remaining path must be empty and the event payload must deserialize into a valid T value.

Tuple Fields§

§0: T

Implementations§

Trait Implementations§

source§

impl<T> Clone for AtomicState<T>

source§

fn clone(&self) -> AtomicState<T>

Returns a copy 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<T> Debug for AtomicState<T>

source§

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

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

impl<T: Serialize + DeserializeOwned + PartialEq + Clone + Default> Default for AtomicState<T>

source§

fn default() -> Self

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

impl<T: Serialize + DeserializeOwned + PartialEq + Clone> From<T> for AtomicState<T>

source§

fn from(value: T) -> Self

Converts to this type from the input type.
source§

impl<T: Serialize + DeserializeOwned + PartialEq + Clone> SessionState for AtomicState<T>

source§

fn perform_event( &mut self, event: &Event, at_path: &[&str], ) -> Result<Consumed, DynError>

Modify the session state using the provided event. The possible outcomes are described by Consumed.
source§

fn refresh( &self, full_path: &[String], at_path: &[&str], ) -> Result<Event, DynError>

“Read” session state into an event without modifying it.

Auto Trait Implementations§

§

impl<T> Freeze for AtomicState<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for AtomicState<T>
where T: RefUnwindSafe,

§

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

§

impl<T> Sync for AtomicState<T>
where T: Sync,

§

impl<T> Unpin for AtomicState<T>
where T: Unpin,

§

impl<T> UnwindSafe for AtomicState<T>
where T: 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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T

§

impl<T> UserEvent for T
where T: Debug + Clone + Send + 'static,