Enum Event

pub enum Event<K> {
    Apply(K),
    Delete(K),
    Init,
    InitApply(K),
    InitDone,
}

Watch events returned from the watcher

Variants

Apply(K)

An object was added or modified

Delete(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.

Init

The watch stream was restarted.

A series of InitApply events are expected to follow until all matching objects have been listed. This event can be used to prepare a buffer for InitApply events.

InitApply(K)

Received an object during Init.

Objects returned here are either from the initial stream using the StreamingList strategy, or from pages using the ListWatch strategy.

These events can be passed up if having a complete set of objects is not a concern. If you need to wait for a complete set, please buffer these events until an InitDone.

InitDone

The initialisation is complete.

This can be used as a signal to replace buffered store contents atomically. No more InitApply events will happen until the next Init event.

Any objects that were previously Applied but are not listed in any of the InitApply events should be assumed to have been Deleted.

Implementations

impl<K> Event<K>

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

👎Deprecated since 0.92.0: unnecessary to flatten a single object. This fn will be removed in 0.96.0.

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>

👎Deprecated since 0.92.0: unnecessary to flatten a single object. This fn will be removed in 0.96.0.

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)) -> Self

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> Clone for Event<K>

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> Debug for Event<K>

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

Formats the value using the given formatter.