pub struct PrimaryMap<K, V> where
    K: EntityRef
{ /* private fields */ }
Expand description

A primary mapping K -> V allocating dense entity references.

The PrimaryMap data structure uses the dense index space to implement a map with a vector.

A primary map contains the main definition of an entity, and it can be used to allocate new entity references with the push method.

There should only be a single PrimaryMap instance for a given EntityRef type, otherwise conflicting references will be created. Using unknown keys for indexing will cause a panic.

Note that PrimaryMap doesn’t implement Deref or DerefMut, which would allow &PrimaryMap<K, V> to convert to &[V]. One of the main advantages of PrimaryMap is that it only allows indexing with the distinct EntityRef key type, so converting to a plain slice would make it easier to use incorrectly. To make a slice of a PrimaryMap, use into_boxed_slice.

Implementations

Create a new empty map.

Create a new empty map with the given capacity.

Check if k is a valid key in the map.

Get the element at k if it exists.

Get the element at k if it exists, mutable version.

Is this map completely empty?

Get the total number of entity references created.

Iterate over all the keys in this map.

Iterate over all the values in this map.

Iterate over all the values in this map, mutable edition.

Iterate over all the keys and values in this map.

Iterate over all the keys and values in this map, mutable edition.

Remove all entries from this map.

Get the key that will be assigned to the next pushed value.

Append v to the mapping, assigning a new key which is returned.

Returns the last element that was inserted in the map.

Reserves capacity for at least additional more elements to be inserted.

Reserves the minimum capacity for exactly additional more elements to be inserted.

Shrinks the capacity of the PrimaryMap as much as possible.

Consumes this PrimaryMap and produces a BoxedSlice.

Performs a binary search on the values with a key extraction function.

Assumes that the values are sorted by the key extracted by the function.

If the value is found then Ok(K) is returned, containing the entity key of the matching value.

If there are multiple matches, then any one of the matches could be returned.

If the value is not found then Err(K) is returned, containing the entity key where a matching element could be inserted while maintaining sorted order.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Creates a value from an iterator. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

Immutable indexing into an PrimaryMap. The indexed value must be in the map.

The returned type after indexing.

Performs the indexing (container[index]) operation. Read more

Mutable indexing into an PrimaryMap.

Performs the mutable indexing (container[index]) operation. Read more

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.