Skip to main content

Operation

Struct Operation 

Source
pub struct Operation<T> { /* private fields */ }
Expand description

A mutation the API accepted and carries out after answering. Its result, a T, is the resource it acted on, or Empty for a delete.

Implementations§

Source§

impl<T: DeserializeOwned> Operation<T>

Source

pub fn new( service: Service, operation: Operation, result_type: &'static str, ) -> Self

The operation operation, which a method of service answered with; its result is the message result_type, such as origincloud.pvs.v1beta1.Volume. The generated clients call it.

Source

pub fn name(&self) -> &str

The operation’s resource name, by which Operation::wait and a service’s OperationClient find it.

Source

pub fn done(&self) -> bool

Whether the operation had finished when it was last read.

Source

pub fn raw(&self) -> &Operation

The operation as it was last read, its metadata included.

Source

pub async fn wait(&mut self) -> Result<T, Error>

Waits until the operation finishes and returns its result, or the Error::Api it failed with. Once it returns a result, reads through the same Client show the operation’s effect.

Each call asks the API to wait up to ClientBuilder::operation_wait, a minute by default, and less than the client’s timeout. A call that times out all the same, such as under a shorter timeout of the HTTP client’s own, counts as the operation not being done yet: the next call is sent, without using up the call’s retries.

It waits as long as the operation takes; to bound that, wrap it in a timeout such as tokio::time::timeout, which stops waiting, not the operation.

Source

pub fn result(&self) -> Result<T, Error>

The result of an operation that is done, or the Error::Api it failed with. It fails with Error::NotDone for an operation that isn’t done yet.

Trait Implementations§

Source§

impl<T> Debug for Operation<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Operation<T>

§

impl<T> !UnwindSafe for Operation<T>

§

impl<T> Freeze for Operation<T>
where PhantomData<fn() -> T>: Freeze,

§

impl<T> Send for Operation<T>
where PhantomData<fn() -> T>: Send,

§

impl<T> Sync for Operation<T>
where PhantomData<fn() -> T>: Sync,

§

impl<T> Unpin for Operation<T>
where PhantomData<fn() -> T>: Unpin,

§

impl<T> UnsafeUnpin for Operation<T>
where PhantomData<fn() -> T>: UnsafeUnpin,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

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

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.

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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