Struct puff_rs::types::map::Map

pub struct Map<K: Clone, V: Clone>(_);

Fast Read-Only Key Value structures.

Puff’s Map type uses std::collections::hash_map::HashMap under the hood. However, in order for it to handle cheap clones, it is wrapped in an Arc, making it read-only.

Maps can only be constructed from types implementing IntoMapBuilder.

use puff_rs::types::Map;

let map = Map::from_builder(vec![(123, 456)]);
assert_eq!(map.get(123), Some(456))

Implementations

impl<K, T> Map<K, T>where
    K: Puff + Hash + Eq,
    T: Puff + Send + 'static,

pub fn new() -> Map<K, T>

Create a new empty Map

Examples

use puff_rs::types::Map;
let map: Map<u32, u32> = Map::new();

pub fn from_builder<B: IntoMapBuilder<K, T>>(builder: B) -> Map<K, T>

Take a datatype that implements IntoMapBuilder and turn it into a read-only Map

Examples

use puff_rs::types::Map;
let map = Map::from_builder(vec![(123, 456)]);

pub fn from_hash_map(hm: HashMap<K, T>) -> Map<K, T>

Create a new Map from a raw HashMap.

Examples

use std::collections::HashMap;
use puff_rs::types::Map;
let map: Map<i32, i32> = Map::from_hash_map(HashMap::new());

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Examples

use puff_rs::types::Map;
let map: Map<i32, i32> = Map::new();
assert!(map.is_empty())

pub fn get(&self, index: K) -> Option<T>

Returns the data associated with the key.

Examples

use puff_rs::types::Map;
let map = Map::from_builder(vec![(123, 456)]);
assert_eq!(map.get(123), Some(456))

pub fn get_key_value(&self, index: K) -> Option<(K, T)>

Returns the key, value pair corresponding to the key

Examples

use puff_rs::types::Map;
let map = Map::from_builder(vec![(123, 456)]);
assert_eq!(map.get_key_value(123), Some((123, 456)))

pub fn len(&self) -> usize

The length of the Map

Examples

use puff_rs::types::Map;
let map: Map<i32, i32> = Map::new();
assert_eq!(map.len(), 0)

pub fn iter(&self) -> IntoIter<K, T>

Iterate over the Map.

Note: normally calling .iter() on a Map iterates over (&K, &V), however, puff’s Map cheaply clones the data so that concrete data is returned instead. If this is not desirable, manually iterate over the underlying type using arc_hashmap.

This applies to all Iterators in Map (keys, values, items).

pub fn items(self) -> IntoIter<K, T>

Iterate over all items, cloning their references.

pub fn keys(self) -> IntoKeys<K, T>

Iterate over all keys, cloning their references.

pub fn values(self) -> IntoValues<K, T>

Iterate over all values, cloning their references.

pub fn arc_hashmap(self) -> Arc<HashMap<K, T>>

Returns a reference to the underlying raw HashMap

Trait Implementations

impl<K: Clone + Clone, V: Clone + Clone> Clone for Map<K, V>

fn clone(&self) -> Map<K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de, K: Deserialize<'de> + Clone + Eq + Hash + Puff, V: Deserialize<'de> + Clone + Puff> Deserialize<'de> for Map<K, V>

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

Deserialize this value from the given Serde deserializer.

impl<K: Puff, V: Puff> Puff for Map<K, V>

fn puff(&self) -> Self

impl<K: Serialize + Clone + Eq + Hash, V: Serialize + Clone> Serialize for Map<K, V>

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

Serialize this value into the given Serde serializer.