std/collections/fixed_map

Library guide · API index and notation

This page is generated from the bundled library in this checkout. Signatures and adjacent source comments are reproduced below; the linked guide explains usage, storage, failures, and platform support.

import "std/collections/fixed_map"

Names used in signatures

Unqualified names denote this package’s types (including other source files in the same package), language built-ins, or generic parameters such as T. Qualified names use the import aliases below. These aliases belong to the library source; import a dependency yourself to use its alias in your program.

Entry

Struct · Source

pub struct Entry<K, V> {
    pub key: K
    pub value: V
}

Map

Struct · Source

Bounded insertion-ordered linear map. E.equal(&K,&K) supplies equality.

pub struct Map<K, V, E> {
    // Private implementation fields omitted.
}

Map.new

Function · Source

pub fn new(slots: &mut[Option<Entry<K, V>>], equality: E) -> Map<K, V, E> from(slots, equality)

Map.next

Function · Source

Cursor starts at zero. Each call yields one logical element.

pub fn next(&self, cursor: &mut usize) -> Option<&Entry<K, V>> from(self)

Map.len

Function · Source

pub fn len(&self) -> usize

Map.capacity

Function · Source

pub fn capacity(&self) -> usize

Map.entry

Function · Source

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

Map.contains

Function · Source

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

Map.get

Function · Source

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

Map.insert

Function · Source

Equal keys replace only the value; retain original key and position.

pub fn insert(&mut self, key: K, value: V) -> Option<V>!collections.CapacityError

Map.remove

Function · Source

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

Map.clear

Function · Source

pub fn clear(&mut self)