Struct kube::runtime::Reflector

pub struct Reflector<K> where
    K: Clone + DeserializeOwned + Send + Meta,  { /* fields omitted */ }

A reflection of Resource state in kubernetes

This watches and caches a Resource<K> by:

• seeding the cache from a large initial list call
• keeping track of initial, and subsequent resourceVersions
• recovering when resourceVersions get desynced

It exposes it's internal state readably through a getter.

Methods

impl<K> Reflector<K> where
    K: Clone + DeserializeOwned + Meta + Send, 

pub fn new(client: APIClient, lp: ListParams, r: Resource) -> Self

Create a reflector with a kube client on a resource

pub async fn init(self) -> Result<Self>

Initializes with a full list of data from a large initial LIST call

pub async fn poll<'_>(&'_ self) -> Result<()>

Run a single watch poll

If this returns an error, it tries a full refresh. This is meant to be run continually in a thread/task. Spawn one.

pub async fn state<'_>(&'_ self) -> Result<Vec<K>>

Read data for users of the reflector

This is instant if you are reading and writing from the same context.

pub fn get(&self, name: &str) -> Result<Option<K>>

Read a single entry by name

Will read in the configured namsepace, or globally on non-namespaced reflectors. If you are using a non-namespaced resources with name clashes, Try Reflector::get_within instead.

pub fn get_within(&self, name: &str, ns: &str) -> Result<Option<K>>

Read a single entry by name within a specific namespace

This is a more specific version of Reflector::get. This is only useful if your reflector is configured to poll across namsepaces.

pub async fn reset<'_>(&'_ self) -> Result<()>

Reset the state with a full LIST call

Same as what is done in State::new.

Trait Implementations

impl<K: Clone> Clone for Reflector<K> where
    K: Clone + DeserializeOwned + Send + Meta, 

fn clone(&self) -> Reflector<K>

Returns a copy of the value.

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

Performs copy-assignment from source.