Struct WeakEntitySet 

pub struct WeakEntitySet(/* private fields */);

A set of entities held weakly

Implementations

impl WeakEntitySet

pub fn get(&self, id: &EntityId) -> Option<Entity>

pub async fn get_or_retrieve<S, E>( &self, state_getter: &S, event_getter: &E, collection_id: &CollectionId, id: &EntityId, ) -> Result<Option<Entity>, RetrievalError>

where S: GetState + Send + Sync, E: GetEvents + Send + Sync,

pub async fn get_retrieve_or_create<S, E>( &self, state_getter: &S, event_getter: &E, collection_id: &CollectionId, id: &EntityId, ) -> Result<Entity, RetrievalError>

where S: GetState + Send + Sync, E: GetEvents + Send + Sync,

Returns a resident entity, or fetches it from storage, or finally creates if neither of the two are found

pub fn create(&self, collection: CollectionId) -> Entity

Create a brand new entity, and add it to the set

pub fn remove_if_phantom(&self, id: &EntityId) -> bool

Evict an entity from the set only if it is absent from storage-backed life: resident with an empty head (or already dead). An empty-head resident is a phantom, materialized speculatively for an incoming update that then failed to apply; leaving it resident makes the entity appear to exist with no state. Returns true if an entry was removed.

pub async fn with_state<S, E>( &self, state_getter: &S, event_getter: &E, id: EntityId, collection_id: CollectionId, state: State, ) -> Result<(Option<bool>, Entity), RetrievalError>

where S: GetState + Send + Sync, E: GetEvents + Send + Sync,

Returns a tuple of (changed, entity) changed is Some(true) if the entity was changed, Some(false) if it already exists and the state was not applied None if the entity was not previously on the local node (either in the WeakEntitySet or in storage)

Trait Implementations

impl Clone for WeakEntitySet

fn clone(&self) -> WeakEntitySet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for WeakEntitySet

fn default() -> WeakEntitySet

Returns the “default value” for a type.