Struct fluvio_sc_schema::store::LocalStore
[−]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
impl<S, C> LocalStore<S, C> where
S: Spec,
C: MetadataItem,
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>>,
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
create arc wrapper
pub async fn read<'a>(
&'_ self
) -> RwLockReadGuard<'_, DualEpochMap<<S as Spec>::IndexKey, MetadataStoreObject<S, C>>>
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>>>
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 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
pub async fn value<K>(
&'_ self,
key: &'_ K
) -> Option<DualEpochCounter<MetadataStoreObject<S, C>>> where
K: Eq + Hash + ?Sized,
<S as Spec>::IndexKey: Borrow<K>,
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>,
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>,
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>
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,
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
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>
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,
impl<S, C> Debug for LocalStore<S, C> where
S: Debug + Spec,
C: Debug + MetadataItem,
<S as Spec>::IndexKey: Debug,
impl<S, C> Default for LocalStore<S, C> where
S: Spec,
C: MetadataItem,
impl<S, C> Default for LocalStore<S, C> where
S: Spec,
C: MetadataItem,
fn default() -> LocalStore<S, C>
fn default() -> LocalStore<S, C>
Returns the “default value” for a type. Read more
impl<S, C> Display for LocalStore<S, C> where
S: Spec,
C: MetadataItem,
impl<S, C> Display for LocalStore<S, C> where
S: Spec,
C: MetadataItem,
sourceimpl<C> PartitionLocalStorePolicy<C> for LocalStore<PartitionSpec, C> where
C: MetadataItem + Send + Sync,
impl<C> PartitionLocalStorePolicy<C> for LocalStore<PartitionSpec, C> where
C: MetadataItem + Send + Sync,
sourcefn partition_spec_for_spu<'life0, 'async_trait>(
&'life0 self,
target_spu: i32
) -> Pin<Box<dyn Future<Output = Vec<(ReplicaKey, PartitionSpec), Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<PartitionSpec, C>: 'async_trait,
fn partition_spec_for_spu<'life0, 'async_trait>(
&'life0 self,
target_spu: i32
) -> Pin<Box<dyn Future<Output = Vec<(ReplicaKey, PartitionSpec), Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<PartitionSpec, C>: 'async_trait,
find all partitions that has spu in the replicas
sourcefn replica_for_spu<'life0, 'async_trait>(
&'life0 self,
target_spu: i32
) -> Pin<Box<dyn Future<Output = Vec<Replica, Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<PartitionSpec, C>: 'async_trait,
fn replica_for_spu<'life0, 'async_trait>(
&'life0 self,
target_spu: i32
) -> Pin<Box<dyn Future<Output = Vec<Replica, Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<PartitionSpec, C>: 'async_trait,
replica msg for target spu
fn names<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Vec<ReplicaKey, Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<PartitionSpec, C>: 'async_trait,
fn topic_partitions<'life0, 'life1, 'async_trait>(
&'life0 self,
topic: &'life1 str
) -> Pin<Box<dyn Future<Output = Vec<MetadataStoreObject<PartitionSpec, C>, Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
'life1: 'async_trait,
LocalStore<PartitionSpec, C>: 'async_trait,
fn count_topic_partitions<'life0, 'life1, 'async_trait>(
&'life0 self,
topic: &'life1 str
) -> Pin<Box<dyn Future<Output = i32> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
'life1: 'async_trait,
LocalStore<PartitionSpec, C>: 'async_trait,
fn topic_partitions_list<'life0, 'life1, 'async_trait>(
&'life0 self,
topic: &'life1 str
) -> Pin<Box<dyn Future<Output = Vec<ReplicaKey, Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
'life1: 'async_trait,
LocalStore<PartitionSpec, C>: 'async_trait,
fn table_fmt<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = String> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<PartitionSpec, C>: 'async_trait,
fn leaders<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Vec<ReplicaLeader, Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<PartitionSpec, C>: 'async_trait,
fn bulk_load<S>(
partitions: Vec<((S, i32), Vec<i32, Global>), Global>
) -> LocalStore<PartitionSpec, C> where
S: Into<String>,
sourceimpl<C> SpuLocalStorePolicy<C> for LocalStore<SpuSpec, C> where
C: MetadataItem + Send + Sync,
impl<C> SpuLocalStorePolicy<C> for LocalStore<SpuSpec, C> where
C: MetadataItem + Send + Sync,
sourcefn online_spu_count<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = i32> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn online_spu_count<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = i32> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
count online SPUs
sourcefn spu_used_for_replica<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = i32> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn spu_used_for_replica<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = i32> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
count spus that can be used for replica
sourcefn spus_in_rack_count<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = i32> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn spus_in_rack_count<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = i32> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
number of spus in rack count
fn online_status<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = HashSet<i32, RandomState>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn online_spu_ids<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Vec<i32, Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn spu_ids<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Vec<i32, Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn online_spus<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Vec<MetadataStoreObject<SpuSpec, C>, Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn custom_spus<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Vec<MetadataStoreObject<SpuSpec, C>, Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn get_by_id<'life0, 'async_trait>(
&'life0 self,
id: i32
) -> Pin<Box<dyn Future<Output = Option<MetadataStoreObject<SpuSpec, C>>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn validate_spu_for_registered<'life0, 'async_trait>(
&'life0 self,
id: i32
) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn all_names<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Vec<String, Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn table_fmt<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = String> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn live_spu_rack_map_sorted<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Vec<(String, Vec<i32, Global>), Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn online_spu_rack_map<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = BTreeMap<String, Vec<i32, Global>>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn online_spus_in_rack(
rack_map: &[(String, Vec<i32, Global>)]
) -> Vec<i32, Global>
fn all_spus_to_spu_msgs<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Vec<Message<SpuSpec>, Global>> + Send + 'async_trait, Global>> where
'life0: 'async_trait,
LocalStore<SpuSpec, C>: 'async_trait,
fn quick(
spus: Vec<(i32, bool, Option<String>), Global>
) -> LocalStore<SpuSpec, C>
sourceimpl<C> TopicLocalStorePolicy<C> for LocalStore<TopicSpec, C> where
C: MetadataItem + Send + Sync,
impl<C> TopicLocalStorePolicy<C> for LocalStore<TopicSpec, C> where
C: MetadataItem + Send + Sync,
Auto Trait Implementations
impl<S, C> !RefUnwindSafe for LocalStore<S, C>
impl<S, C> Send for LocalStore<S, C> where
C: Send,
S: Send,
<S as Spec>::IndexKey: Send,
<S as Spec>::Status: Send,
impl<S, C> Sync for LocalStore<S, C> where
C: Send + Sync,
S: Send + Sync,
<S as Spec>::IndexKey: Send + Sync,
<S as Spec>::Status: Send + Sync,
impl<S, C> Unpin for LocalStore<S, C> where
C: Unpin,
S: Unpin,
<S as Spec>::IndexKey: Unpin,
<S as Spec>::Status: Unpin,
impl<S, C> UnwindSafe for LocalStore<S, C> where
C: UnwindSafe,
S: UnwindSafe,
<S as Spec>::IndexKey: UnwindSafe,
<S as Spec>::Status: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more