Struct cvrdt_exposition::one_way_boolean::OneWayBoolean

pub struct OneWayBoolean {
    pub flag: bool,
}

A boolean flag that, once true, can never revert to false

Examples

Example usage, including demonstrating some properties:

use cvrdt_exposition::{Grow, OneWayBoolean};
let mut x = OneWayBoolean::new(false);
x.add(());
assert_eq!(x.payload(), true);
assert_eq!(x.query(&()), true);
for payload in vec![true, false] {
    let y = OneWayBoolean::new(payload);
    assert_eq!(x.merge(&y).payload(), y.merge(&x).payload());
    assert!(y.le(&x));
}

Fields

flag: bool

The internal state of a OneWayBoolean is a single boolean flag

Trait Implementations

impl Clone for OneWayBoolean

fn clone(&self) -> OneWayBoolean

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OneWayBoolean

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

Formats the value using the given formatter.

impl Grow for OneWayBoolean

type Payload = bool

The internal state of our CvRDT; sufficient to build a new copy via new. Required to implement Eq for testing and verification.

type Update = ()

Message to update our internal state

type Query = ()

Message to query the Value of our CvRDT

type Value = bool

The response to a Query

fn new(payload: Self::Payload) -> Self

Create a new version of our data structure from the given Payload

fn payload(&self) -> Self::Payload

Retrieve the Payload (internal state) of this CvRDT

fn add(&mut self, _update: Self::Update)

Add an item to the data structure, mutating this CvRDT in place

fn le(&self, other: &OneWayBoolean) -> bool

Is this CvRDT ≤ another in the semilattice's partial order?

fn merge(&self, other: &OneWayBoolean) -> Self

Merge this data structure and another into a new CvRDT

fn query(&self, _query: &Self::Query) -> Self::Value

Query the data structure to get some Value