Struct ObservableHashMap 

pub struct ObservableHashMap<K, V, Codec = Default> { /* private fields */ }

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

A hash map 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 map.

Implementations

impl<K, V, Codec> ObservableHashMap<K, V, Codec>

where K: Eq + Hash + Clone + RemoteSend, V: 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 map.

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) -> HashMapSubscription<K, V, 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 map.

The current contents of the hash map 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, ) -> HashMapSubscription<K, V, 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 map with incremental sending of the current contents.

The current contents of the hash map 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, k: K, v: V) -> Option<V>

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

Inserts a value under a key.

A HashMapEvent::Set change event is sent.

Returns the value previously stored under the key, if any.

Panics

Panics when done has been called before.

pub fn remove<Q>(&mut self, k: &Q) -> Option<V>

where K: 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 HashMapEvent::Remove change event is sent.

The value is returned.

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 HashMapEvent::Clear change event is sent.

Panics

Panics when done has been called before.

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

where F: FnMut(&K, &mut V) -> 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 HashMapEvent::Remove change event is sent for every element that is removed.

Panics

Panics when done has been called before.

pub fn entry(&mut self, key: K) -> Entry<'_, K, V, Codec>

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

Gets the given key’s corresponding entry in the map for in-place manipulation.

Panics

Panics when done has been called before.

pub fn get_mut<Q>(&mut self, k: &Q) -> Option<RefMut<'_, K, V, Codec>>

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

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

Gets a mutable reference to the value under the specified key.

A HashMapEvent::Set change event is sent if the reference is accessed mutably.

Panics

Panics when done has been called before.

pub fn iter_mut(&mut self) -> IterMut<'_, K, V, Codec>

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

Mutably iterates over the key-value pairs.

A HashMapEvent::Set change event is sent for each value that is accessed mutably.

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 map as much as possible.

A HashMapEvent::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 map and notifies are subscribers that no further events will occur.

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

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 map will panic in this case.

pub fn into_inner(self) -> HashMap<K, V>

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

Extracts the underlying hash map.

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

Methods from Deref<Target = HashMap<K, V>>

pub fn capacity(&self) -> usize

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

This number is a lower bound; the HashMap<K, V> might be able to hold more, but is guaranteed to be able to hold at least this many.

Examples

use std::collections::HashMap;
let map: HashMap<i32, i32> = HashMap::with_capacity(100);
assert!(map.capacity() >= 100);

pub fn keys(&self) -> Keys<'_, K, V>

An iterator visiting all keys in arbitrary order. The iterator element type is &'a K.

Examples

use std::collections::HashMap;

let map = HashMap::from([
    ("a", 1),
    ("b", 2),
    ("c", 3),
]);

for key in map.keys() {
    println!("{key}");
}

Performance

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

pub fn values(&self) -> Values<'_, K, V>

An iterator visiting all values in arbitrary order. The iterator element type is &'a V.

Examples

use std::collections::HashMap;

let map = HashMap::from([
    ("a", 1),
    ("b", 2),
    ("c", 3),
]);

for val in map.values() {
    println!("{val}");
}

Performance

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

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

An iterator visiting all key-value pairs in arbitrary order. The iterator element type is (&'a K, &'a V).

Examples

use std::collections::HashMap;

let map = HashMap::from([
    ("a", 1),
    ("b", 2),
    ("c", 3),
]);

for (key, val) in map.iter() {
    println!("key: {key} val: {val}");
}

Performance

In the current implementation, iterating over map 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 map.

Examples

use std::collections::HashMap;

let mut a = HashMap::new();
assert_eq!(a.len(), 0);
a.insert(1, "a");
assert_eq!(a.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Examples

use std::collections::HashMap;

let mut a = HashMap::new();
assert!(a.is_empty());
a.insert(1, "a");
assert!(!a.is_empty());

pub fn hasher(&self) -> &S

Returns a reference to the map’s BuildHasher.

Examples

use std::collections::HashMap;
use std::hash::RandomState;

let hasher = RandomState::new();
let map: HashMap<i32, i32> = HashMap::with_hasher(hasher);
let hasher: &RandomState = map.hasher();

pub fn get<Q>(&self, k: &Q) -> Option<&V>

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

Returns a reference to the value corresponding to the key.

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

Examples

use std::collections::HashMap;

let mut map = HashMap::new();
map.insert(1, "a");
assert_eq!(map.get(&1), Some(&"a"));
assert_eq!(map.get(&2), None);

pub fn get_key_value<Q>(&self, k: &Q) -> Option<(&K, &V)>

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

Returns the key-value pair corresponding to the supplied key. This is potentially useful:

• for key types where non-identical keys can be considered equal;
• for getting the &K stored key value from a borrowed &Q lookup key; or
• for getting a reference to a key with the same lifetime as the collection.

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

Examples

use std::collections::HashMap;
use std::hash::{Hash, Hasher};

#[derive(Clone, Copy, Debug)]
struct S {
    id: u32,
    name: &'static str, // ignored by equality and hashing operations
}

impl PartialEq for S {
    fn eq(&self, other: &S) -> bool {
        self.id == other.id
    }
}

impl Eq for S {}

impl Hash for S {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.id.hash(state);
    }
}

let j_a = S { id: 1, name: "Jessica" };
let j_b = S { id: 1, name: "Jess" };
let p = S { id: 2, name: "Paul" };
assert_eq!(j_a, j_b);

let mut map = HashMap::new();
map.insert(j_a, "Paris");
assert_eq!(map.get_key_value(&j_a), Some((&j_a, &"Paris")));
assert_eq!(map.get_key_value(&j_b), Some((&j_a, &"Paris"))); // the notable case
assert_eq!(map.get_key_value(&p), None);

pub fn contains_key<Q>(&self, k: &Q) -> bool

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

Returns true if the map contains a value for the specified key.

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

Examples

use std::collections::HashMap;

let mut map = HashMap::new();
map.insert(1, "a");
assert_eq!(map.contains_key(&1), true);
assert_eq!(map.contains_key(&2), false);

Trait Implementations

impl<K, V, Codec> Debug for ObservableHashMap<K, V, Codec>

where K: Debug, V: Debug,

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

Formats the value using the given formatter.

impl<K, V, Codec> Default for ObservableHashMap<K, V, Codec>

where K: Clone + RemoteSend, V: Clone + RemoteSend, Codec: Codec,

fn default() -> Self

Returns the “default value” for a type.

impl<K, V, Codec> Deref for ObservableHashMap<K, V, Codec>

type Target = HashMap<K, V>

The resulting type after dereferencing.

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

Dereferences the value.

impl<K, V, Codec> Extend<(K, V)> for ObservableHashMap<K, V, Codec>

where K: Eq + Hash + Clone + RemoteSend, V: Clone + RemoteSend, Codec: Codec,

fn extend<I: IntoIterator<Item = (K, V)>>(&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<K, V, Codec> From<HashMap<K, V>> for ObservableHashMap<K, V, Codec>

where K: Clone + RemoteSend, V: Clone + RemoteSend, Codec: Codec,

fn from(hm: HashMap<K, V>) -> Self

Converts to this type from the input type.

impl<K, V, Codec> From<ObservableHashMap<K, V, Codec>> for HashMap<K, V>

fn from(ohm: ObservableHashMap<K, V, Codec>) -> Self

Converts to this type from the input type.