Struct Versioned 

pub struct Versioned<T> { /* private fields */ }

A value and the version it is currently at.

Both ends of a connection hold one. The sender calls commit, the receiver calls apply, and the version and fingerprints travel between them inside a VersionedDelta.

Implementations

impl<T> Versioned<T>

pub fn new(value: T) -> Self

Starts a value at version 0.

Both ends have to start from the same value; sending a Versioned<T> whole is how a receiver catches up after a Rejected.

pub fn version(&self) -> u64

The version this value is at.

pub fn get(&self) -> &T

Borrows the value.

pub fn into_inner(self) -> T

Takes the value back out, discarding the version.

impl<T: Fingerprint> Versioned<T>

pub fn fingerprint(&self) -> u64

The fingerprint of the value as it stands.

impl<T: Delta + Fingerprint + Clone> Versioned<T>

pub fn commit(&mut self, new: T) -> Option<VersionedDelta<T::Output>>

Moves to new and produces the delta that gets a peer here.

Returns None when nothing changed, in which case the version does not advance either — an update that would do nothing costs no message and no number.

T: Clone is needed because Delta::delta consumes both sides and the new value has to be kept as well as diffed.

impl<T: Delta + Fingerprint> Versioned<T>

pub fn apply( &mut self, delta: VersionedDelta<T::Output>, ) -> Result<Applied, Rejected>

Applies a delta, or explains why it does not belong here.

A delta that has already been applied is reported as Applied::Stale and does nothing, so duplicate delivery is safe. A Rejected leaves the version untouched, which means a later delta in the same stream will fail too rather than papering over the hole — the only way forward is to replace the whole value.

Trait Implementations

impl<T: Clone> Clone for Versioned<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Versioned<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Versioned<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: Eq> Eq for Versioned<T>

impl<T: PartialEq> PartialEq for Versioned<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T> Serialize for Versioned<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: PartialEq> StructuralPartialEq for Versioned<T>