Struct kube_client::api::entry::OccupiedEntry

pub struct OccupiedEntry<'a, K> { /* private fields */ }

A view into a single object that exists

The object may exist because it existed at the time of call to Api::entry, or because it was created by Entry::or_insert.

Implementations

impl<'a, K> OccupiedEntry<'a, K>

pub fn get(&self) -> &K

Borrow the object

pub fn get_mut(&mut self) -> &mut K

Borrow the object mutably

OccupiedEntry::commit must be called afterwards for any changes to be persisted.

pub fn and_modify(self, f: impl FnOnce(&mut K)) -> Self

Let f modify the object

OccupiedEntry::commit must be called afterwards for any changes to be persisted.

pub fn into_object(self) -> K

Take ownership over the object

pub async fn commit(&mut self, pp: &PostParams) -> Result<(), CommitError>

where K: Resource + DeserializeOwned + Serialize + Clone + Debug,

Save the object to the Kubernetes API, if any changes have been made

The OccupiedEntry is updated with the new object (including changes made by the API server, such as .metadata.resource_version).

Errors

This function can fail due to transient errors, or due to write conflicts (for example: if another client created the object between the calls to Api::entry and OccupiedEntry::commit, or because another client modified the object in the meantime).

Any retries should be coarse-grained enough to also include the call to Api::entry, so that the latest state can be fetched.

Trait Implementations

impl<'a, K: Debug> Debug for OccupiedEntry<'a, K>

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

Formats the value using the given formatter.