Crate typed_index_collection

source ·
Expand description

Collections of objects with typed indices and buildin identifier support.

Macros

  • impl_id
    Implements the Id trait for an object. For example, if an object Animal has a field ‘species_id’ which is a pointer toward another Object of type Species, you can implements Id with the following example. You can also implement Id for Animal itself (the identifier of an Animal is its own field that must be named id).
  • impl_with_id
    Implement trait WithId automatically for a type.

Structs

  • Collection
    The Collection object looks like a Map<Idx<T>, T>, with opaque keys. Then, you can easily store indices and don’t mess up between different types of indices.
  • CollectionWithId
    A Collection with identifier support.
  • Idx
    Typed index.
  • RefMut
    The structure returned by CollectionWithId::index_mut.

Enums

  • Error
    Typed error for typed_index_collection.

Traits

  • Id
    An object that has a unique identifier.
  • WithId
    An object that can be assigned an identifier.

Type Definitions

  • Iter
    The type returned by collection::iter.