Skip to main content

EntityCache

Struct EntityCache 

Source
pub struct EntityCache { /* private fields */ }
Expand description

Entity cache that maintains full projected entities with LRU eviction.

The cache is populated as mutations flow through the projector, regardless of subscriber state. When a new subscriber connects, they receive snapshots of all cached entities for their requested view.

Implementations§

Source§

impl EntityCache

Source

pub fn new() -> Self

Create a new entity cache with default configuration

Source

pub fn with_config(config: EntityCacheConfig) -> Self

Create a new entity cache with custom configuration

Source

pub fn max_entities_per_view(&self) -> usize

Maximum number of entities cached per view.

Derived sorted view caches are bounded by the same value so they never hold more entities than their source view caches.

Source

pub async fn upsert(&self, view_id: &str, key: &str, patch: Value)

Source

pub async fn upsert_with_append( &self, view_id: &str, key: &str, patch: Value, append_paths: &[String], )

Source

pub async fn get_all(&self, view_id: &str) -> Vec<(String, Value)>

Get all cached entities for a view.

Returns a vector of (key, entity) pairs for sending as snapshots to new subscribers.

Source

pub async fn get_after( &self, view_id: &str, cursor: &str, limit: Option<usize>, ) -> Vec<(String, Value)>

Get entities with _seq greater than the provided cursor.

Returns entities that have been updated after the given cursor, sorted by _seq in ascending order. Useful for resuming from a specific point in the stream.

Source

pub async fn get(&self, view_id: &str, key: &str) -> Option<Value>

Get a specific entity from the cache

Source

pub async fn remove(&self, view_id: &str, key: &str) -> Option<Value>

Remove one entity after a source-wide delete.

Source

pub async fn len(&self, view_id: &str) -> usize

Get the number of cached entities for a view

Source

pub async fn is_empty(&self, view_id: &str) -> bool

Check if the cache for a view is empty

Source

pub fn snapshot_config(&self) -> SnapshotBatchConfig

Get the snapshot batch configuration

Source

pub async fn clear(&self, view_id: &str)

Clear all cached entities for a view

Source

pub async fn clear_all(&self)

Source

pub async fn dump(&self) -> Vec<(String, Vec<(String, Value)>)>

Dump every view’s entities for a state snapshot.

Entries are ordered most-recently-used first; Self::hydrate relies on that to reconstruct LRU eviction order.

Source

pub async fn hydrate(&self, views: Vec<(String, Vec<(String, Value)>)>)

Restore entities dumped by Self::dump, preserving LRU order.

Entities are inserted as-is (no merge): a snapshot holds fully projected entities, not patches.

Source

pub async fn stats(&self) -> CacheStats

Trait Implementations§

Source§

impl Clone for EntityCache

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for EntityCache

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more