Struct ObservableHashSet 

pub struct ObservableHashSet<T, Codec = Default> { /* private fields */ }

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

A hash set that emits an event for each change.

Use subscribe to obtain an event stream that can be used for building a mirror of this hash set.

Implementations

impl<T, Codec> ObservableHashSet<T, Codec>

where T: Eq + Hash + Clone + RemoteSend, Codec: Codec,

pub fn new() -> Self

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Creates an empty observable hash set.

pub fn set_error_handler<E>(&mut self, on_err: E)

where E: Fn(SendError) + Send + Sync + 'static,

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Sets the error handler function that is called when sending an event fails.

pub fn subscribe(&self, buffer: usize) -> HashSetSubscription<T, Codec>

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Subscribes to change events from this observable hash set.

The current contents of the hash set is included with the subscription.

buffer specifies the maximum size of the event buffer for this subscription in number of events. If it is exceeded the subscription is shed and the receiver gets a RecvError::Lagged.

pub fn subscribe_incremental( &self, buffer: usize, ) -> HashSetSubscription<T, Codec>

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Subscribes to change events from this observable hash set with incremental sending of the current contents.

The current contents of the hash set are sent incrementally.

buffer specifies the maximum size of the event buffer for this subscription in number of events. If it is exceeded the subscription is shed and the receiver gets a RecvError::Lagged.

pub fn subscriber_count(&self) -> usize

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Current number of subscribers.

pub fn notifier(&self) -> ChangeNotifier

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Returns a change notifier that can be used locally to be notified of changes to this collection.

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

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Adds a value to the set.

A HashSetEvent::Set change event is sent.

Returns whether the set did have this value present.

Panics

Panics when done has been called before.

pub fn replace(&mut self, value: T) -> Option<T>

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Adds a value to the set, replacing the existing value, if any.

A HashSetEvent::Set change event is sent.

Returns the replaced value, if any.

Panics

Panics when done has been called before.

pub fn remove<Q>(&mut self, value: &Q) -> bool

where T: Borrow<Q>, Q: Hash + Eq,

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Removes the value under the specified key.

A HashSetEvent::Remove change event is sent.

Returns whether the set did have this value present.

Panics

Panics when done has been called before.

pub fn take<Q>(&mut self, value: &Q) -> Option<T>

where T: Borrow<Q>, Q: Hash + Eq,

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Removes the value under the specified key.

A HashSetEvent::Remove change event is sent.

Returns the removed value, if any.

Panics

Panics when done has been called before.

pub fn clear(&mut self)

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Removes all items.

A HashSetEvent::Clear change event is sent.

Panics

Panics when done has been called before.

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&T) -> bool,

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Retains only the elements specified by the predicate.

A HashSetEvent::Remove change event is sent for every element that is removed.

Panics

Panics when done has been called before.

pub fn shrink_to_fit(&mut self)

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Shrinks the capacity of the hash set as much as possible.

A HashSetEvent::ShrinkToFit change event is sent.

Panics

Panics when done has been called before.

pub fn done(&mut self)

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Prevents further changes of this hash set and notifies are subscribers that no further events will occur.

Methods that modify the hash set will panic after this has been called. It is still possible to subscribe to this observable hash set.

pub fn is_done(&self) -> bool

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Returns true if done has been called and further changes are prohibited.

Methods that modify the hash set will panic in this case.

pub fn into_inner(self) -> HashSet<T>

👎Deprecated: remoc-obs has been integrated into remoc as module remoc::robs. Please update your references.

Extracts the underlying hash set.

If done has not been called before this method, subscribers will receive an error.

Methods from Deref<Target = HashSet<T>>

pub fn capacity(&self) -> usize

Returns the number of elements the set can hold without reallocating.

Examples

use std::collections::HashSet;
let set: HashSet<i32> = HashSet::with_capacity(100);
assert!(set.capacity() >= 100);

pub fn iter(&self) -> Iter<'_, T>

An iterator visiting all elements in arbitrary order. The iterator element type is &'a T.

Examples

use std::collections::HashSet;
let mut set = HashSet::new();
set.insert("a");
set.insert("b");

// Will print in an arbitrary order.
for x in set.iter() {
    println!("{x}");
}

Performance

In the current implementation, iterating over set takes O(capacity) time instead of O(len) because it internally visits empty buckets too.

pub fn len(&self) -> usize

Returns the number of elements in the set.

Examples

use std::collections::HashSet;

let mut v = HashSet::new();
assert_eq!(v.len(), 0);
v.insert(1);
assert_eq!(v.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if the set contains no elements.

Examples

use std::collections::HashSet;

let mut v = HashSet::new();
assert!(v.is_empty());
v.insert(1);
assert!(!v.is_empty());

pub fn hasher(&self) -> &S

Returns a reference to the set’s BuildHasher.

Examples

use std::collections::HashSet;
use std::hash::RandomState;

let hasher = RandomState::new();
let set: HashSet<i32> = HashSet::with_hasher(hasher);
let hasher: &RandomState = set.hasher();

pub fn difference<'a>( &'a self, other: &'a HashSet<T, S>, ) -> Difference<'a, T, S>

Visits the values representing the difference, i.e., the values that are in self but not in other.

Examples

use std::collections::HashSet;
let a = HashSet::from([1, 2, 3]);
let b = HashSet::from([4, 2, 3, 4]);

// Can be seen as `a - b`.
for x in a.difference(&b) {
    println!("{x}"); // Print 1
}

let diff: HashSet<_> = a.difference(&b).collect();
assert_eq!(diff, [1].iter().collect());

// Note that difference is not symmetric,
// and `b - a` means something else:
let diff: HashSet<_> = b.difference(&a).collect();
assert_eq!(diff, [4].iter().collect());

pub fn symmetric_difference<'a>( &'a self, other: &'a HashSet<T, S>, ) -> SymmetricDifference<'a, T, S>

Visits the values representing the symmetric difference, i.e., the values that are in self or in other but not in both.

Examples

use std::collections::HashSet;
let a = HashSet::from([1, 2, 3]);
let b = HashSet::from([4, 2, 3, 4]);

// Print 1, 4 in arbitrary order.
for x in a.symmetric_difference(&b) {
    println!("{x}");
}

let diff1: HashSet<_> = a.symmetric_difference(&b).collect();
let diff2: HashSet<_> = b.symmetric_difference(&a).collect();

assert_eq!(diff1, diff2);
assert_eq!(diff1, [1, 4].iter().collect());

pub fn intersection<'a>( &'a self, other: &'a HashSet<T, S>, ) -> Intersection<'a, T, S>

Visits the values representing the intersection, i.e., the values that are both in self and other.

When an equal element is present in self and other then the resulting Intersection may yield references to one or the other. This can be relevant if T contains fields which are not compared by its Eq implementation, and may hold different value between the two equal copies of T in the two sets.

Examples

use std::collections::HashSet;
let a = HashSet::from([1, 2, 3]);
let b = HashSet::from([4, 2, 3, 4]);

// Print 2, 3 in arbitrary order.
for x in a.intersection(&b) {
    println!("{x}");
}

let intersection: HashSet<_> = a.intersection(&b).collect();
assert_eq!(intersection, [2, 3].iter().collect());

pub fn union<'a>(&'a self, other: &'a HashSet<T, S>) -> Union<'a, T, S>

Visits the values representing the union, i.e., all the values in self or other, without duplicates.

Examples

use std::collections::HashSet;
let a = HashSet::from([1, 2, 3]);
let b = HashSet::from([4, 2, 3, 4]);

// Print 1, 2, 3, 4 in arbitrary order.
for x in a.union(&b) {
    println!("{x}");
}

let union: HashSet<_> = a.union(&b).collect();
assert_eq!(union, [1, 2, 3, 4].iter().collect());

pub fn contains<Q>(&self, value: &Q) -> bool

where T: Borrow<Q>, Q: Hash + Eq + ?Sized,

Returns true if the set contains a value.

The value may be any borrowed form of the set’s value type, but Hash and Eq on the borrowed form must match those for the value type.

Examples

use std::collections::HashSet;

let set = HashSet::from([1, 2, 3]);
assert_eq!(set.contains(&1), true);
assert_eq!(set.contains(&4), false);

pub fn get<Q>(&self, value: &Q) -> Option<&T>

where T: Borrow<Q>, Q: Hash + Eq + ?Sized,

Returns a reference to the value in the set, if any, that is equal to the given value.

The value may be any borrowed form of the set’s value type, but Hash and Eq on the borrowed form must match those for the value type.

Examples

use std::collections::HashSet;

let set = HashSet::from([1, 2, 3]);
assert_eq!(set.get(&2), Some(&2));
assert_eq!(set.get(&4), None);

pub fn is_disjoint(&self, other: &HashSet<T, S>) -> bool

Returns true if self has no elements in common with other. This is equivalent to checking for an empty intersection.

Examples

use std::collections::HashSet;

let a = HashSet::from([1, 2, 3]);
let mut b = HashSet::new();

assert_eq!(a.is_disjoint(&b), true);
b.insert(4);
assert_eq!(a.is_disjoint(&b), true);
b.insert(1);
assert_eq!(a.is_disjoint(&b), false);

pub fn is_subset(&self, other: &HashSet<T, S>) -> bool

Returns true if the set is a subset of another, i.e., other contains at least all the values in self.

Examples

use std::collections::HashSet;

let sup = HashSet::from([1, 2, 3]);
let mut set = HashSet::new();

assert_eq!(set.is_subset(&sup), true);
set.insert(2);
assert_eq!(set.is_subset(&sup), true);
set.insert(4);
assert_eq!(set.is_subset(&sup), false);

pub fn is_superset(&self, other: &HashSet<T, S>) -> bool

Returns true if the set is a superset of another, i.e., self contains at least all the values in other.

Examples

use std::collections::HashSet;

let sub = HashSet::from([1, 2]);
let mut set = HashSet::new();

assert_eq!(set.is_superset(&sub), false);

set.insert(0);
set.insert(1);
assert_eq!(set.is_superset(&sub), false);

set.insert(2);
assert_eq!(set.is_superset(&sub), true);

Trait Implementations

impl<T, Codec> Debug for ObservableHashSet<T, Codec>

where T: Debug,

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

Formats the value using the given formatter.

impl<T, Codec> Default for ObservableHashSet<T, Codec>

where T: Clone + RemoteSend, Codec: Codec,

fn default() -> Self

Returns the “default value” for a type.

impl<T, Codec> Deref for ObservableHashSet<T, Codec>

type Target = HashSet<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, Codec> Extend<T> for ObservableHashSet<T, Codec>

where T: RemoteSend + Eq + Hash + Clone, Codec: Codec,

fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T, Codec> From<HashSet<T>> for ObservableHashSet<T, Codec>

where T: Clone + RemoteSend, Codec: Codec,

fn from(hs: HashSet<T>) -> Self

Converts to this type from the input type.

impl<T, Codec> From<ObservableHashSet<T, Codec>> for HashSet<T>

fn from(ohs: ObservableHashSet<T, Codec>) -> Self

Converts to this type from the input type.