Struct Map

pub struct Map<'a, K = u32, V = u32>(/* private fields */);

Map objects are integer-to-integer hash-maps.

The map can be specialized to work over other integer-like types, like chars.

Implementations

impl<K, V> Map<'static, K, V>

pub fn new() -> Result<Self, AllocationError>

Creates a new, initially empty map.

impl<'a, K, V> Map<'a, K, V>

pub fn is_empty(&self) -> bool

Tests whether map is empty i.e. contains no elements.

pub fn len(&self) -> usize

Returns the number of key-value pairs in the set.

pub fn clear(&mut self)

Clears out the contents of a map.

pub fn clone_static(&self) -> Map<'static, K, V>

Constructs a copy of the map with 'static lifetime.

pub fn update(&mut self, other: &Self)

Adds the contents of other to map.

pub fn keys(&self) -> Result<Set<'static, K>, AllocationError>

Gets the set of keys that have been defined.

pub fn values(&self) -> Result<Set<'static, V>, AllocationError>

Gets the set of values that are associated with a key.

impl<'a, K, V> Map<'a, K, V>

where K: Into<u32>, V: Into<u32>,

pub fn contains(&self, key: K) -> bool

Tests whether the map contains a key.

pub fn remove(&mut self, key: K)

Removes key and its associated value from map.

pub fn insert(&mut self, key: K, value: V)

Inserts a key-value pair to map.

impl<'a, K, V> Map<'a, K, V>

where K: Into<u32>, V: TryFrom<u32>,

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

Gets a value based on a key.

impl<'a, K, V> Map<'a, K, V>

where K: TryFrom<u32>, V: TryFrom<u32>,

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

Gets an iterator over key-value pairs stored in the map.

impl<'a, K, V> Map<'a, K, V>

pub fn into_raw(self) -> *mut hb_map_t

Converts the map into raw sys::hb_map_t pointer.

This method transfers the ownership of the map to the caller. It is up to the caller to call sys::hb_map_destroy to free the object, or call Self::from_raw to convert it back into Map.

pub fn as_raw(&self) -> *mut hb_map_t

Exposes the raw inner pointer without transferring the ownership.

Unlike Self::into_raw, this method does not transfer the ownership of the pointer to the caller.

pub unsafe fn from_raw(map: *mut hb_map_t) -> Self

Constructs a map from raw sys::hb_map_t object.

Safety

The given map pointer must either be constructed by some Harfbuzz function, or be returned from Self::into_raw.

Trait Implementations

impl<'a, K, V> Clone for Map<'a, K, V>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, K, V> Debug for Map<'a, K, V>

where K: TryFrom<u32> + Debug, V: TryFrom<u32> + Debug,

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

Formats the value using the given formatter.

impl<'a, K, V> FromIterator<(K, V)> for Map<'a, K, V>

where K: Into<u32>, V: Into<u32>,

fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a, K, V> Hash for Map<'a, K, V>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'m, 'a, K, V> IntoIterator for &'m Map<'a, K, V>

where K: TryFrom<u32>, V: TryFrom<u32>,

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = MapIter<'m, 'a, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, K, V> PartialEq for Map<'a, K, V>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, K, V> Eq for Map<'a, K, V>

where K: Eq, V: Eq,