Skip to main content

RequestIdempotency

Struct RequestIdempotency 

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

Whether one outbound request may be replayed byte-for-byte without an idempotency key — the single fact a retry middleware needs and cannot work out for itself.

Attached to every request this crate sends as a reqwest_middleware request extension, so a middleware reads it with extensions.get::<RequestIdempotency>(). Only observable under the middleware feature: reqwest 0.13 keeps reqwest::Request::extensions_mut() pub(crate), so a bare reqwest::Client has no extension map a caller can write to (see client::http::HttpRequestBuilder::with_extension).

Absent means “assume not idempotent.” A middleware that finds no RequestIdempotency in the extensions is talking to something other than this client, or to a build where the extension could not be attached; failing closed there is the same rule the rest of this crate follows.

§How the value is chosen

By default it is derived from the HTTP method (RequestIdempotency::for_method, RFC 9110 §9.2.2), which is exactly right for REST CRUD: GET/DELETE are idempotent, POST/PATCH are not. It is not right for two cases the method alone cannot express, and for those the caller overrides it with CratestackClient::with_idempotency:

  • RPC. Every RPC call is POST /rpc/{op_id}, so the method carries no information at all. The op’s real answer is the idempotent_by_default field on the OpDescriptor the schema macro emits for that op (cratestack_core::OpDescriptor) — true for reads and @query procedures, false for mutations.
  • REST procedures. POST /$procs/<name> is a POST whatever the procedure does, so a @query procedure looks non-idempotent to the method-derived default.

Note that the REST-transport descriptor (cratestack_core::RouteTransportDescriptor) does not carry an idempotent_by_default field today — only the RPC-transport OpDescriptor does. Wiring either descriptor through the generated client so callers don’t have to pass it by hand is follow-up work; this type and CratestackClient::with_idempotency are the runtime half that makes it expressible at all.

Implementations§

Source§

impl RequestIdempotency

Source

pub const IDEMPOTENT: Self

The request may be retried as-is.

Source

pub const NOT_IDEMPOTENT: Self

The request must not be retried without an idempotency key.

Source

pub const fn new(idempotent: bool) -> Self

Wraps a raw flag — e.g. an OpDescriptor’s idempotent_by_default.

Source

pub const fn is_idempotent(self) -> bool

Source

pub fn for_method(method: &Method) -> Self

The RFC 9110 §9.2.2 answer for a method: GET, HEAD, PUT, DELETE, OPTIONS and TRACE are idempotent; everything else — POST and PATCH included — is not.

PATCH is deliberately in the second group: RFC 5789 §2 makes it explicitly non-idempotent, and cratestack’s generated PATCH route is a partial update, which a retry after an unseen success can re-apply against a changed row.

Trait Implementations§

Source§

impl Clone for RequestIdempotency

Source§

fn clone(&self) -> RequestIdempotency

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 Copy for RequestIdempotency

Source§

impl Debug for RequestIdempotency

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for RequestIdempotency

Source§

impl Hash for RequestIdempotency

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for RequestIdempotency

Source§

fn eq(&self, other: &RequestIdempotency) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for RequestIdempotency

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

§

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
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

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

§

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
§

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 = Infallible

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

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

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

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