Skip to main content

Operation

Struct Operation 

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

A request the client has not sent yet. Generated service methods build one from a Route; crate::Client::request builds one for anything the model does not cover.

Implementations§

Source§

impl Operation

Source

pub fn id(&self) -> &str

The operation id, or METHOD /path for a raw call.

Source

pub fn method(&self) -> &Method

The HTTP method.

Source

pub fn path(&self) -> &str

The path, account and parameters filled in.

Source

pub fn retry_policy(&self) -> Option<&RetryPolicy>

The retry policy the operation will be sent under, once one has been settled.

Source

pub fn query(&mut self, name: &str, value: impl Display) -> &mut Operation

Adds a query parameter.

Source

pub fn query_optional<T: Display>( &mut self, name: &str, value: Option<&T>, ) -> &mut Operation

Adds a query parameter when there is a value for it.

Source

pub fn query_all<T: Display>( &mut self, name: &str, values: &[T], ) -> &mut Operation

Adds a query parameter once per value, the way Rails reads ids[]=1&ids[]=2.

Source

pub fn query_all_optional<T: Display>( &mut self, name: &str, values: Option<&[T]>, ) -> &mut Operation

Adds a repeated query parameter when there are values for it.

Source

pub fn header(&mut self, name: HeaderName, value: HeaderValue) -> &mut Operation

Adds a header of the caller’s own. Credentials go on through the client’s crate::AuthStrategy, not here.

Source

pub fn json<T: Serialize + ?Sized>( &mut self, body: &T, ) -> Result<&mut Operation, Error>

Sends a JSON body.

Source

pub fn body_bytes( &mut self, content_type: impl Into<String>, bytes: Bytes, ) -> &mut Operation

A body the caller encoded, for the representations the model does not describe.

Source

pub fn info(&mut self, info: OperationInfo) -> &mut Operation

Replaces the whole of what the operation announces itself as to the client’s crate::observability::Hooks.

Source

pub fn operation_name( &mut self, name: impl Into<Cow<'static, str>>, ) -> &mut Operation

Announces the operation as something other than the route it sends.

Source

pub fn resource_type( &mut self, resource_type: impl Into<Cow<'static, str>>, ) -> &mut Operation

Names the kind of record the operation acts on.

Source

pub fn resource_id(&mut self, resource_id: impl Display) -> &mut Operation

Names the record the operation acts on. Generated methods set this from the path parameter that names it.

Source

pub fn idempotent(&mut self, idempotent: bool) -> &mut Operation

Marks the operation as safe to resend, or not, regardless of its HTTP method. A POST marked idempotent is retried like a GET.

Source

pub fn no_retry(&mut self) -> &mut Operation

Sends the operation once, whatever the route or the client would have allowed.

Source

pub fn retry(&mut self, policy: RetryPolicy) -> &mut Operation

Sends the operation under a policy of the caller’s own. The client’s ceilings still apply.

Source

pub fn no_cache(&mut self) -> &mut Operation

Reads past the response cache for this send, so the answer is Fizzy’s own.

Trait Implementations§

Source§

impl Clone for Operation

Source§

fn clone(&self) -> Operation

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Operation

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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