Struct EntityTable 

pub struct EntityTable { /* private fields */ }

The entity table.

Canonical sequences share one pool rather than owning a collection each, so a structure with three hundred entities holds one allocation for their sequences instead of three hundred.

Implementations

impl EntityTable

pub fn len(&self) -> usize

The number of entities.

pub fn is_empty(&self) -> bool

Returns true when the structure declares no entities.

pub fn push( &mut self, id: SymbolId, kind: EntityKind, description: OptionalSymbol, canonical_sequence: &[SymbolId], ) -> Result<EntityIndex, CapacityError>

Appends an entity, returning its position.

Errors

Returns CapacityError when the entity table exceeds its index space.

pub fn push_without_id( &mut self, kind: EntityKind, description: OptionalSymbol, canonical_sequence: &[SymbolId], ) -> Result<EntityIndex, CapacityError>

Appends an entity whose source did not declare an identifier.

Errors

Returns CapacityError when the entity table exceeds its index space.

pub fn kind(&self, entity: EntityIndex) -> Option<EntityKind>

What kind of species this entity is.

pub fn id(&self, entity: EntityIndex) -> Option<SymbolId>

The identifier the file gave this entity.

pub fn find_by_id(&self, id: SymbolId) -> Option<EntityIndex>

The entity carrying id, where the file declared one.

Entity tables are normally small and this is used while building one chain at a time, not in an atom loop. Keeping the lookup here avoids a second index whose lifetime and invalidation would duplicate the table.

pub fn description(&self, entity: EntityIndex) -> Option<SymbolId>

The entity’s description, if the file carried one.

pub fn canonical_sequence(&self, entity: EntityIndex) -> &[SymbolId]

The sequence this entity should have, one component per position.

Compare it against the residues a chain actually holds to find what was not modelled.

pub fn iter(&self) -> impl Iterator<Item = EntityIndex> + '_

Every entity position.

Trait Implementations

impl Clone for EntityTable

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityTable

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

Formats the value using the given formatter.

impl Default for EntityTable

fn default() -> Self

Returns the “default value” for a type.