Struct aper::data_structures::Atom

pub struct Atom<T: Clone + PartialEq + Debug + Unpin + Send + Sync> { /* fields omitted */ }

A StateMachine representing a value which is “atomic” from the perspective of managing state: it is only ever changed by completely replacing it.

Implementations

impl<T: Send + Sync> Atom<T> where
    T: 'static + Serialize + DeserializeOwned + Unpin + Send + Clone + PartialEq + Debug, 

pub fn new(initial: T) -> Self

Create a new Atom with a given initial value.

pub fn value(&self) -> &T

Retrieve the current value of the atom.

pub fn replace(&self, replacement: T) -> ReplaceAtom<T>

Return a transition which, when processed, will replace the value of the atom with the value provided.

Trait Implementations

impl<T: Clone + PartialEq + Debug + Unpin + Send + Sync> Clone for Atom<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone + PartialEq + Unpin + Send + Sync> Debug for Atom<T>

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

Formats the value using the given formatter.

impl<T: Send + Sync> Default for Atom<T> where
    T: Default + 'static + Clone + PartialEq + Debug + Unpin + Send + Serialize + DeserializeOwned, 

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: Clone + PartialEq + Debug + Unpin + Send + Sync> Deserialize<'de> for Atom<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq + Clone + Debug + Unpin + Send + Sync> PartialEq<Atom<T>> for Atom<T>

fn eq(&self, other: &Atom<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Atom<T>) -> bool

This method tests for !=.

impl<T: Clone + PartialEq + Debug + Unpin + Send + Sync> Serialize for Atom<T> where
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T: Send + Sync> StateMachine for Atom<T> where
    T: 'static + Serialize + DeserializeOwned + Unpin + Send + Clone + PartialEq + Debug, 

type Transition = ReplaceAtom<T>

The StateMachine::Transition type associates another type with this state machine as its transitions.

type Conflict = NeverConflict

fn apply(
    &mut self,
    transition_event: Self::Transition
) -> Result<(), NeverConflict>

Update the state machine according to the given [Transition]. This method must be deterministic: calling it on a clone of the state with a clone of the [Transition] must result in the same state, even at a different time and on a different machine. This is the requirement that allows Aper to keep the state in sync across multiple machines.

impl<T: Clone + PartialEq + Debug + Unpin + Send + Sync> StructuralPartialEq for Atom<T>