Struct kube_client::api::entry::OccupiedEntry

source · [−]

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

Available on crate feature client only.

Expand description

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. Read more

Auto Trait Implementations

impl<'a, K> !RefUnwindSafe for OccupiedEntry<'a, K>

impl<'a, K> Send for OccupiedEntry<'a, K> where
K: Send,

impl<'a, K> Sync for OccupiedEntry<'a, K> where
K: Sync,

impl<'a, K> Unpin for OccupiedEntry<'a, K> where
K: Unpin,

impl<'a, K> !UnwindSafe for OccupiedEntry<'a, K>

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · 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.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more