Struct LocalEntityMap 

pub struct LocalEntityMap { /* private fields */ }

Bidirectional lookup table between GlobalEntity identifiers and their connection-local HostEntity or RemoteEntity counterparts.

Implementations

impl LocalEntityMap

pub fn new(host_type: HostType) -> LocalEntityMap

Creates an empty map for the given host_type side of a connection.

pub fn host_type(&self) -> HostType

Returns whether this map belongs to a server or client side.

pub fn insert_with_host_entity( &mut self, global_entity: GlobalEntity, host_entity: HostEntity, )

Registers a host-owned mapping from global_entity to host_entity, panicking on duplicate keys.

pub fn insert_with_static_host_entity( &mut self, global_entity: GlobalEntity, host_entity: HostEntity, )

Registers a static host-owned mapping from global_entity to host_entity, panicking on duplicate keys.

pub fn insert_with_remote_entity( &mut self, global_entity: GlobalEntity, remote_entity: RemoteEntity, )

Registers a remote-owned mapping from global_entity to remote_entity, panicking on duplicate keys.

pub fn global_entity_from_remote( &self, remote_entity: &RemoteEntity, ) -> Option<&GlobalEntity>

Returns the GlobalEntity mapped from remote_entity, if one exists.

pub fn global_entity_from_host( &self, host_entity: &HostEntity, ) -> Option<&GlobalEntity>

Returns the GlobalEntity mapped from host_entity, if one exists.

pub fn remove_by_global_entity( &mut self, global_entity: &GlobalEntity, ) -> Option<LocalEntityRecord>

Removes the record for global_entity and cleans up the reverse index, returning the record if it existed.

pub fn contains_global_entity(&self, global_entity: &GlobalEntity) -> bool

Returns true if global_entity is currently registered in the map.

pub fn contains_host_entity(&self, host_entity: &HostEntity) -> bool

Returns true if host_entity is currently registered in the map.

pub fn contains_remote_entity(&self, remote_entity: &RemoteEntity) -> bool

Returns true if remote_entity is currently registered in the map.

pub fn iter(&self) -> impl Iterator<Item = (&GlobalEntity, &LocalEntityRecord)>

Iterates over all (GlobalEntity, LocalEntityRecord) pairs currently in the map.

pub fn entity_converter(&self) -> &dyn LocalEntityAndGlobalEntityConverter

Returns self as a read-only LocalEntityAndGlobalEntityConverter reference.

pub fn install_entity_redirect( &mut self, old_entity: OwnedLocalEntity, new_entity: OwnedLocalEntity, )

Installs a redirect so that lookups of old_entity transparently return new_entity for a TTL period.

Trait Implementations

impl LocalEntityAndGlobalEntityConverter for LocalEntityMap

fn global_entity_to_host_entity( &self, global_entity: &GlobalEntity, ) -> Result<HostEntity, EntityDoesNotExistError>

Returns the HostEntity for global_entity if one is registered, or an error otherwise.

fn global_entity_to_remote_entity( &self, global_entity: &GlobalEntity, ) -> Result<RemoteEntity, EntityDoesNotExistError>

Returns the RemoteEntity for global_entity if one is registered, or an error otherwise.

fn global_entity_to_owned_entity( &self, global_entity: &GlobalEntity, ) -> Result<OwnedLocalEntity, EntityDoesNotExistError>

Returns the OwnedLocalEntity (host or remote) for global_entity, or an error if not found.

fn host_entity_to_global_entity( &self, host_entity: &HostEntity, ) -> Result<GlobalEntity, EntityDoesNotExistError>

Returns the GlobalEntity for a dynamic host_entity, or an error if not found.

fn static_host_entity_to_global_entity( &self, host_entity: &HostEntity, ) -> Result<GlobalEntity, EntityDoesNotExistError>

Returns the GlobalEntity for a static host_entity, or an error if not found.

fn remote_entity_to_global_entity( &self, remote_entity: &RemoteEntity, ) -> Result<GlobalEntity, EntityDoesNotExistError>

Returns the GlobalEntity for remote_entity, or an error if not found.

fn apply_entity_redirect(&self, entity: &OwnedLocalEntity) -> OwnedLocalEntity

Returns the current redirect target for entity, or entity unchanged if no redirect is installed.

fn owned_entity_to_global_entity( &self, owned_entity: &OwnedLocalEntity, ) -> Result<GlobalEntity, EntityDoesNotExistError>

Returns the GlobalEntity for owned_entity, dispatching to the appropriate host or remote lookup.