kube_runtime::reflector::store

Struct Store

Source
pub struct Store<K: 'static + Lookup>
where K::DynamicType: Hash + Eq,
{ /* private fields */ }
Expand description

A readable cache of Kubernetes objects of kind K

Cloning will produce a new reference to the same backing store.

Cannot be constructed directly since one writer handle is required, use Writer::as_reader() instead.

Implementations§

Source§

impl<K: 'static + Clone + Lookup> Store<K>
where K::DynamicType: Eq + Hash + Clone,

Source

pub async fn wait_until_ready(&self) -> Result<(), WriterDropped>

Wait for the store to be populated by Kubernetes.

Note that polling this will not await the source of the stream that populates the Writer. The reflector stream must be awaited separately.

§Errors

Returns an error if the Writer was dropped before any value was written.

Source

pub fn get(&self, key: &ObjectRef<K>) -> Option<Arc<K>>

Retrieve a clone() of the entry referred to by key, if it is in the cache.

key.namespace is ignored for cluster-scoped resources.

Note that this is a cache and may be stale. Deleted objects may still exist in the cache despite having been deleted in the cluster, and new objects may not yet exist in the cache. If any of these are a problem for you then you should abort your reconciler and retry later. If you use kube_rt::controller then you can do this by returning an error and specifying a reasonable error_policy.

Source

pub fn state(&self) -> Vec<Arc<K>>

Return a full snapshot of the current values

Source

pub fn find<P>(&self, predicate: P) -> Option<Arc<K>>
where P: Fn(&K) -> bool,

Retrieve a clone() of the entry found by the given predicate

Source

pub fn len(&self) -> usize

Return the number of elements in the store

Source

pub fn is_empty(&self) -> bool

Return whether the store is empty

Trait Implementations§

Source§

impl<K: 'static + Lookup> Clone for Store<K>
where K::DynamicType: Hash + Eq, Arc<RwLock<AHashMap<ObjectRef<K>, Arc<K>>>>: Clone, Arc<DelayedInit<()>>: Clone,

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K> Debug for Store<K>
where K::DynamicType: Hash + Eq + Debug, K: Debug + 'static + Lookup,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<K> Freeze for Store<K>

§

impl<K> !RefUnwindSafe for Store<K>

§

impl<K> Send for Store<K>
where <K as Lookup>::DynamicType: Send + Sync, K: Sync + Send,

§

impl<K> Sync for Store<K>
where <K as Lookup>::DynamicType: Send + Sync, K: Sync + Send,

§

impl<K> Unpin for Store<K>

§

impl<K> !UnwindSafe for Store<K>

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, dst: *mut u8)

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

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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