Skip to main content

OrSet

Struct OrSet 

Source
pub struct OrSet<T>
where T: Clone + Eq + Hash,
{ /* private fields */ }
Expand description

Observed-Remove Set

A CRDT set that supports add and remove operations. Each add operation gets a unique ID, and removes only affect observed add operations. This ensures that concurrent add/remove operations are handled correctly.

§Example

use oxigdal_sync::crdt::{OrSet, Crdt};

let mut set1 = OrSet::new("device-1".to_string());
set1.insert("apple".to_string());
set1.insert("banana".to_string());

let mut set2 = OrSet::new("device-2".to_string());
set2.insert("cherry".to_string());

set1.merge(&set2).ok();
assert_eq!(set1.len(), 3);

Implementations§

Source§

impl<T> OrSet<T>
where T: Clone + Eq + Hash,

Source

pub fn new(device_id: DeviceId) -> Self

Creates a new OR-Set

§Arguments
  • device_id - The device ID
Source

pub fn insert(&mut self, element: T) -> bool

Inserts an element into the set

§Arguments
  • element - The element to insert
§Returns

True if the element was newly inserted, false if already present

Source

pub fn remove(&mut self, element: &T) -> bool

Removes an element from the set

§Arguments
  • element - The element to remove
§Returns

True if the element was present and removed

Source

pub fn contains(&self, element: &T) -> bool

Checks if the set contains an element

§Arguments
  • element - The element to check
§Returns

True if the element is in the set

Source

pub fn len(&self) -> usize

Gets the number of elements in the set

Source

pub fn is_empty(&self) -> bool

Checks if the set is empty

Source

pub fn iter(&self) -> impl Iterator<Item = &T>

Gets an iterator over the elements

Source

pub fn to_hashset(&self) -> HashSet<T>

Converts the set to a HashSet

Source

pub fn clear(&mut self)

Clears all elements from the set

Trait Implementations§

Source§

impl<T> Clone for OrSet<T>
where T: Clone + Eq + Hash + Clone,

Source§

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

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<T> Crdt for OrSet<T>
where T: Clone + Eq + Hash + Serialize + for<'de> Deserialize<'de>,

Source§

fn merge(&mut self, other: &Self) -> SyncResult<()>

Merges another CRDT state into this one Read more
Source§

fn dominated_by(&self, other: &Self) -> bool

Checks if this CRDT is causally dominated by another Read more
Source§

impl<T> Debug for OrSet<T>
where T: Clone + Eq + Hash + Debug,

Source§

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

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

impl<'de, T> Deserialize<'de> for OrSet<T>
where T: Clone + Eq + Hash + DeserializeOwned,

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T> DeviceAware for OrSet<T>
where T: Clone + Eq + Hash + Serialize + for<'de> Deserialize<'de>,

Source§

fn device_id(&self) -> &DeviceId

Gets the device ID associated with this CRDT
Source§

fn set_device_id(&mut self, device_id: DeviceId)

Sets the device ID
Source§

impl<T> PartialEq for OrSet<T>
where T: Clone + Eq + Hash,

Source§

fn eq(&self, other: &Self) -> 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<T> Serialize for OrSet<T>
where T: Clone + Eq + Hash + Serialize,

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<T> Freeze for OrSet<T>

§

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

§

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

§

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

§

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

§

impl<T> UnsafeUnpin for OrSet<T>

§

impl<T> UnwindSafe for OrSet<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, dest: *mut u8)

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

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,