Struct boa::builtins::map::ordered_map::OrderedMap

pub struct OrderedMap<K, V, S = RandomState>(_)
 where
    K: Hash + Eq;

A newtype wrapping indexmap::IndexMap

Implementations

impl<K, V> OrderedMap<K, V> where
    K: Hash + Eq, 

pub fn new() -> Self

pub fn with_capacity(capacity: usize) -> Self

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 insert(&mut self, key: K, value: V) -> Option<V>

Insert a key-value pair in the map.

If an equivalent key already exists in the map: the key remains and retains in its place in the order, its corresponding value is updated with value and the older value is returned inside Some(_).

If no equivalent key existed in the map: the new key-value pair is inserted, last in order, and None is returned.

Computes in O(1) time (amortized average).

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

Remove the key-value pair equivalent to key and return its value.

Like Vec::remove, the pair is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

Return None if key is not in map.

Computes in O(n) time (average).

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

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

Computes in O(1) time (average).

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 iter(&self) -> Iter<'_, K, V>

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

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

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

Computes in O(1) time (average).

Trait Implementations

impl<K: Clone, V: Clone, S: Clone> Clone for OrderedMap<K, V, S> where
    K: Hash + Eq, 

pub fn clone(&self) -> OrderedMap<K, V, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Hash + Eq + Debug, V: Debug> Debug for OrderedMap<K, V>

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

Formats the value using the given formatter.

impl<K: Hash + Eq, V> Default for OrderedMap<K, V>

pub fn default() -> Self

Returns the "default value" for a type.

impl<K: Eq + Hash + Trace, V: Trace, S: BuildHasher> Finalize for OrderedMap<K, V, S>

pub fn finalize(&self)

impl<'a, K, V, S> IntoIterator for &'a OrderedMap<K, V, S> where
    K: Hash + Eq,
    S: BuildHasher, 

type Item = (&'a K, &'a V)

The type of the elements being iterated over.

type IntoIter = Iter<'a, K, V>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, K, V, S> IntoIterator for &'a mut OrderedMap<K, V, S> where
    K: Hash + Eq,
    S: BuildHasher, 

type Item = (&'a K, &'a mut V)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, K, V>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V, S> IntoIterator for OrderedMap<K, V, S> where
    K: Hash + Eq,
    S: BuildHasher, 

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> IntoIter<K, V>

Creates an iterator from a value.

impl<K: Eq + Hash + Trace, V: Trace, S: BuildHasher> Trace for OrderedMap<K, V, S>

pub unsafe fn trace(&self)

Marks all contained Gcs.

pub unsafe fn root(&self)

Increments the root-count of all contained Gcs.

pub unsafe fn unroot(&self)

Decrements the root-count of all contained Gcs.

pub fn finalize_glue(&self)

Runs Finalize::finalize() on this object and all contained subobjects