Enum kube::runtime::watcher::Event

pub enum Event<K> {
    Applied(K),
    Deleted(K),
    Restarted(Vec<K>),
}

Available on crate feature runtime only.

Watch events returned from the watcher

Variants

Applied(K)

An object was added or modified

Deleted(K)

An object was deleted

NOTE: This should not be used for managing persistent state elsewhere, since events may be lost if the watcher is unavailable. Use Finalizers instead.

Restarted(Vec<K>)

The watch stream was restarted, so Deleted events may have been missed

Should be used as a signal to replace the store contents atomically.

Any objects that were previously Applied but are not listed in this event should be assumed to have been Deleted.

Implementations

impl<K> Event<K>

pub fn into_iter_applied(self) -> impl Iterator<Item = K>

Flattens out all objects that were added or modified in the event.

Deleted objects are ignored, all objects mentioned by Restarted events are emitted individually.

pub fn into_iter_touched(self) -> impl Iterator<Item = K>

Flattens out all objects that were added, modified, or deleted in the event.

Note that Deleted events may be missed when restarting the stream. Use finalizers or owner references instead if you care about cleaning up external resources after deleted objects.

pub fn modify(self, f: impl FnMut(&mut K)) -> Event<K>

Map each object in an event through a mutator fn

This allows for memory optimizations in watch streams. If you are chaining a watch stream into a reflector as an in memory state store, you can control the space used by each object by dropping fields.

use k8s_openapi::api::core::v1::Pod;
use kube::ResourceExt;
event.modify(|pod| {
    pod.managed_fields_mut().clear();
    pod.annotations_mut().clear();
    pod.status = None;
});

Trait Implementations

impl<K> Clone for Event<K>

where K: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K> Debug for Event<K>

where K: Debug,

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

Formats the value using the given formatter.