Enum implicit_clone::sync::IMap

pub enum IMap<K: Eq + Hash + ImplicitClone + 'static, V: PartialEq + ImplicitClone + 'static> {
    Static(&'static [(K, V)]),
    Rc(Arc<IndexMap<K, V>>),
}

Available on crate feature map only.

An immutable hash map type inspired by Immutable.js.

This type is cheap to clone and thus implements ImplicitClone. It can be created based on a &'static [(K, V)], or based on a reference counted IndexMap.

This type has the least stable API at the moment and is subject to change a lot before the 1.0 release.

Variants

Static(&'static [(K, V)])

A (small) static map.

Rc(Arc<IndexMap<K, V>>)

An reference counted map.

Implementations

impl<K: Eq + Hash + ImplicitClone + 'static, V: PartialEq + ImplicitClone + 'static> IMap<K, V>

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

Return an iterator over the key-value pairs of the map, in their order.

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

Return an iterator over the keys of the map, in their order.

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

Return an iterator over the values of the map, in their order.

pub fn len(&self) -> usize

Return the number of key-value pairs in the map.

Computes in O(1) time.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Computes in O(1) time.

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

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

Return a clone to the value stored for key, if it is present, else None.

Computes in O(1) time (average).

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

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

Return clones to the key-value pair stored for key, if it is present, else None.

Computes in O(1) time (average).

pub fn get_full<Q>(&self, key: &Q) -> Option<(usize, K, V)>

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

Return item index, key and value

pub fn get_index(&self, index: usize) -> Option<(K, V)>

Get a key-value pair by index.

Valid indices are 0 <= index < self.len()

Computes in O(1) time.

pub fn get_index_of<Q>(&self, key: &Q) -> Option<usize>

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

Return item index, if it exists in the map.

Computes in O(1) time (average).

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

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

Return true if an equivalent to key exists in the map.

Computes in O(1) time (average).

pub fn last(&self) -> Option<(K, V)>

Get the last key-value pair.

Computes in O(1) time.

Trait Implementations

impl<K: Eq + Hash + ImplicitClone + 'static, V: PartialEq + ImplicitClone + 'static> Clone for IMap<K, V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Eq + Hash + ImplicitClone + 'static, V: Debug + PartialEq + ImplicitClone + 'static> Debug for IMap<K, V>

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

Formats the value using the given formatter.

impl<K: Eq + Hash + ImplicitClone + 'static, V: PartialEq + ImplicitClone + 'static> Default for IMap<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K, V> Deserialize<'de> for IMap<K, V>

where K: Eq + Hash + ImplicitClone + 'static + Deserialize<'de>, V: PartialEq + ImplicitClone + 'static + Deserialize<'de>,

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<K: Eq + Hash + ImplicitClone + 'static, V: PartialEq + ImplicitClone + 'static> From<&'static [(K, V)]> for IMap<K, V>

fn from(a: &'static [(K, V)]) -> IMap<K, V>

Converts to this type from the input type.

impl<K: Eq + Hash + ImplicitClone + 'static, V: PartialEq + ImplicitClone + 'static> From<&IMap<K, V>> for IMap<K, V>

fn from(a: &IMap<K, V>) -> IMap<K, V>

Converts to this type from the input type.

impl<K: Eq + Hash + ImplicitClone + 'static, V: PartialEq + ImplicitClone + 'static> From<Arc<IndexMap<K, V>>> for IMap<K, V>

fn from(a: Rc<Map<K, V>>) -> IMap<K, V>

Converts to this type from the input type.

impl<K: Eq + Hash + ImplicitClone + 'static, V: PartialEq + ImplicitClone + 'static> From<IndexMap<K, V>> for IMap<K, V>

fn from(a: Map<K, V>) -> IMap<K, V>

Converts to this type from the input type.

impl<K: Eq + Hash + ImplicitClone + 'static, V: PartialEq + ImplicitClone + 'static> FromIterator<(K, V)> for IMap<K, V>

fn from_iter<I: IntoIterator<Item = (K, V)>>(it: I) -> Self

Creates a value from an iterator.

impl<K: Eq + Hash + ImplicitClone + 'static, V: PartialEq + ImplicitClone + 'static> ImplicitClone for IMap<K, V>

fn implicit_clone(&self) -> Self

This function is not magic; it is literally defined as

impl<K: PartialEq + Eq + Hash + ImplicitClone + 'static, V: PartialEq + PartialEq + ImplicitClone + 'static> PartialEq for IMap<K, V>

fn eq(&self, other: &IMap<K, V>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K, V> Serialize for IMap<K, V>

where K: Eq + Hash + ImplicitClone + 'static + Serialize, V: PartialEq + ImplicitClone + 'static + Serialize,

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<K: Eq + Eq + Hash + ImplicitClone + 'static, V: Eq + PartialEq + ImplicitClone + 'static> Eq for IMap<K, V>

impl<K: Eq + Hash + ImplicitClone + 'static, V: PartialEq + ImplicitClone + 'static> StructuralPartialEq for IMap<K, V>