Struct fluvio_stream_model::store::LocalStore
source · pub struct LocalStore<S, C>where
S: Spec,
C: MetadataItem,{ /* private fields */ }
Expand description
Idempotent local memory cache of meta objects.
There are only 2 write operations are permitted: sync and apply changes which are idempotent.
For read, read guards are provided which provide hash map API using deref.
Hash values are wrapped in EpochCounter. EpochCounter is also deref.
Using async lock to ensure read/write are thread safe.
Implementations§
source§impl<S, C> LocalStore<S, C>where
S: Spec,
C: MetadataItem,
impl<S, C> LocalStore<S, C>where
S: Spec,
C: MetadataItem,
sourcepub fn bulk_new(objects: Vec<impl Into<MetadataStoreObject<S, C>>>) -> Self
pub fn bulk_new(objects: Vec<impl Into<MetadataStoreObject<S, C>>>) -> Self
initialize local stores with list of metadata objects
create arc wrapper
sourcepub async fn read<'a>(
&self
) -> RwLockReadGuard<'_, DualEpochMap<S::IndexKey, MetadataStoreObject<S, C>>>
pub async fn read<'a>( &self ) -> RwLockReadGuard<'_, DualEpochMap<S::IndexKey, MetadataStoreObject<S, C>>>
Read guard
sourcepub fn init_epoch(&self) -> DualEpochCounter<()>
pub fn init_epoch(&self) -> DualEpochCounter<()>
initial epoch that should be used store will always have epoch greater than init_epoch if there are any changes
sourcepub async fn value<K>(
&self,
key: &K
) -> Option<DualEpochCounter<MetadataStoreObject<S, C>>>
pub async fn value<K>( &self, key: &K ) -> Option<DualEpochCounter<MetadataStoreObject<S, C>>>
copy of the value
sourcepub async fn find_and_do<K, F>(&self, key: &K, func: F) -> Option<()>
pub async fn find_and_do<K, F>(&self, key: &K, func: F) -> Option<()>
iterate over entry
pub async fn contains_key<K>(&self, key: &K) -> bool
pub async fn count(&self) -> usize
pub async fn clone_specs(&self) -> Vec<S>
pub async fn clone_keys(&self) -> Vec<S::IndexKey>
pub async fn clone_values(&self) -> Vec<MetadataStoreObject<S, C>>
pub fn event_publisher(&self) -> &EventPublisher
sourcepub fn change_listener(self: &Arc<Self>) -> ChangeListener<S, C>
pub fn change_listener(self: &Arc<Self>) -> ChangeListener<S, C>
create new change listener
sourcepub async fn wait_for_first_change(self: &Arc<Self>)
pub async fn wait_for_first_change(self: &Arc<Self>)
returns once there is at least one change recorded by the the event_publisher
source§impl<S, C> LocalStore<S, C>where
S: Spec,
C: MetadataItem,
impl<S, C> LocalStore<S, C>where
S: Spec,
C: MetadataItem,
sourcepub async fn sync_all(
&self,
incoming_changes: Vec<MetadataStoreObject<S, C>>
) -> SyncStatus
pub async fn sync_all( &self, incoming_changes: Vec<MetadataStoreObject<S, C>> ) -> SyncStatus
sync with incoming changes as source of truth. any objects not in incoming list will be deleted after sync operation, prior history will be removed and any subsequent change query will return full list instead of changes
sourcepub async fn apply_changes(
&self,
changes: Vec<LSUpdate<S, C>>
) -> Option<SyncStatus>
pub async fn apply_changes( &self, changes: Vec<LSUpdate<S, C>> ) -> Option<SyncStatus>
apply changes to this store if item doesn’t exit, it will be treated as add if item exist but different, it will be treated as updated epoch will be only incremented if there are actual changes which means this is idempotent operations. same add result in only 1 single epoch increase.