Struct fluvio_controlplane_metadata::store::LocalStore

pub struct LocalStore<S, C> where
    S: Spec,
    C: MetadataItem, { /* private fields */ }

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

impl<S, C> LocalStore<S, C> where
    S: Spec,
    C: MetadataItem, 

pub fn bulk_new<N>(objects: Vec<N, Global>) -> LocalStore<S, C> where
    N: Into<MetadataStoreObject<S, C>>, 

initialize local stores with list of metadata objects

pub fn new_shared() -> Arc<LocalStore<S, C>>

create arc wrapper

pub async fn read<'a>(
    &self
) -> RwLockReadGuard<'_, DualEpochMap<<S as Spec>::IndexKey, MetadataStoreObject<S, C>>>

Read guard

pub async fn write<'a>(
    &self
) -> RwLockWriteGuard<'_, DualEpochMap<<S as Spec>::IndexKey, MetadataStoreObject<S, C>>>

write guard, this is private, use sync API to make changes

pub async fn epoch(&self) -> i64

current epoch

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

pub async fn value<K>(
    &self,
    key: &K
) -> Option<DualEpochCounter<MetadataStoreObject<S, C>>> where
    K: Eq + Hash + ?Sized,
    <S as Spec>::IndexKey: Borrow<K>, 

copy of the value

pub async fn spec<K>(&self, key: &K) -> Option<S> where
    K: Eq + Hash + ?Sized,
    <S as Spec>::IndexKey: Borrow<K>, 

copy spec

pub async fn find_and_do<K, F>(&self, key: &K, func: F) -> Option<()> where
    F: FnMut(&MetadataStoreObject<S, C>),
    K: Eq + Hash,
    <S as Spec>::IndexKey: Borrow<K>, 

iterate over entry

pub async fn contains_key<K>(&self, key: &K) -> bool where
    K: Eq + Hash + ?Sized,
    <S as Spec>::IndexKey: Borrow<K>, 

pub async fn count(&self) -> i32

pub async fn clone_specs(&self) -> Vec<S, Global>

pub async fn clone_keys(&self) -> Vec<<S as Spec>::IndexKey, Global>

pub async fn clone_values(&self) -> Vec<MetadataStoreObject<S, C>, Global>

pub fn event_publisher(&self) -> &EventPublisher

pub fn change_listener(self: &Arc<LocalStore<S, C>>) -> ChangeListener<S, C>

create new change listener

impl<S, C> LocalStore<S, C> where
    S: Spec + PartialEq<S>,
    C: MetadataItem + PartialEq<C>,
    <S as Spec>::Status: PartialEq<<S as Spec>::Status>,
    <S as Spec>::IndexKey: Display, 

pub async fn sync_all(
    &self,
    incoming_changes: Vec<MetadataStoreObject<S, C>, Global>
) -> 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

pub async fn apply_changes(
    &self,
    changes: Vec<LSUpdate<S, C>, Global>
) -> 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.

Trait Implementations

impl<S, C> Debug for LocalStore<S, C> where
    S: Debug + Spec,
    C: Debug + MetadataItem,
    <S as Spec>::IndexKey: Debug, 

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

Formats the value using the given formatter.

impl<S, C> Default for LocalStore<S, C> where
    S: Spec,
    C: MetadataItem, 

fn default() -> LocalStore<S, C>

Returns the “default value” for a type.

impl<S, C> Display for LocalStore<S, C> where
    S: Spec,
    C: MetadataItem, 

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

Formats the value using the given formatter.