Struct Entity 

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

An entity represents a unique thing within a collection. Entity can only be constructed via a WeakEntitySet which provides duplication guarantees.

Implementations

impl Entity

pub fn id(&self) -> EntityId

pub fn collection(&self) -> &CollectionId

pub fn head(&self) -> Clock

pub fn is_writable(&self) -> bool

Check if this entity is writable (i.e., it’s a transaction fork that’s still alive)

pub fn to_state(&self) -> Result<State, StateError>

pub fn to_entity_state(&self) -> Result<EntityState, StateError>

pub fn create(id: EntityId, collection: CollectionId) -> Self

pub fn view<V: View>(&self) -> Option<V>

pub async fn apply_event<G>( &self, getter: &G, event: &Event, ) -> Result<bool, MutationError>

where G: GetEvents<Id = EventId, Event = Event>,

Attempt to apply an event to the entity

pub async fn apply_state<G>( &self, getter: &G, state: &State, ) -> Result<bool, MutationError>

where G: GetEvents<Id = EventId, Event = Event>,

pub fn snapshot(&self, trx_alive: Arc<AtomicBool>) -> Self

Create a snapshot of the Entity which is detached from this one, and will not receive the updates this one does The trx_alive parameter tracks whether the transaction that owns this snapshot is still alive

pub fn broadcast(&self) -> &Broadcast

Get a reference to the entity’s broadcast for Signal implementations

pub fn get_backend<P: PropertyBackend>(&self) -> Result<Arc<P>, RetrievalError>

Get a specific backend, creating it if it doesn’t exist

pub fn values(&self) -> Vec<(String, Option<Value>)>

Trait Implementations

impl AbstractEntity for Entity

fn collection(&self) -> CollectionId

fn id(&self) -> &EntityId

fn value(&self, field: &str) -> Option<Value>

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl Deref for Entity

type Target = EntityInner

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for Entity

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

Formats the value using the given formatter.

impl Filterable for Entity

fn collection(&self) -> &str

fn value(&self, name: &str) -> Option<Value>

impl<SE, PA> GapFetcher<Entity> for QueryGapFetcher<SE, PA>

where SE: StorageEngine + 'static, PA: PolicyAgent + 'static,

fn fetch_gap<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, collection_id: &'life1 CollectionId, selection: &'life2 Selection, last_entity: Option<&'life3 Entity>, gap_size: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<Entity>, RetrievalError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Fetch entities to fill a gap in a limited result set

impl PartialEq for Entity

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.