Struct Idempotency 

pub struct Idempotency { /* private fields */ }

Idempotency-key middleware, see the module documentation

Implementations

impl Idempotency

pub fn new() -> Self

In-memory store, POST and PATCH, results kept for 24 hours

pub fn with_store(store: impl IdempotencyStore) -> Self

pub fn shared_seed(self, seed: impl AsRef<[u8]>) -> Self

Secret that makes the hashes behind scopes and payload fingerprints identical on every instance. Required with a store shared between processes (Redis): by default each process hashes with its own random seed, and instances would disagree about whose key is whose. Keep it secret and at least 16 bytes: it keeps clients from crafting colliding scopes.

pub fn methods<I: IntoIterator<Item = Method>>(self, methods: I) -> Self

Methods the key applies to (default POST and PATCH; PUT and DELETE are idempotent by definition)

pub fn ttl(self, ttl: Duration) -> Self

How long a finished response can be replayed (default 24 hours)

pub fn lock_ttl(self, lock_ttl: Duration) -> Self

How long a running request blocks retries if it never finishes (default 60 seconds)

pub fn max_response_bytes(self, max: usize) -> Self

Largest response body that is kept for replay (default 256 KiB). Larger responses are sent normally but not stored, so a retry runs the handler again.

pub fn required(self) -> Self

Answer 400 when the header is missing instead of running the handler without protection

pub fn header(self, name: &str) -> Self

Header carrying the key (default Idempotency-Key)

pub fn scope_by<F>(self, f: F) -> Self

where F: Fn(&Request) -> String + Send + Sync + 'static,

Whose keys these are. Keys of different scopes never collide. The default is the Authorization + Cookie headers; use a user or tenant id when you have one.

Trait Implementations

impl Default for Idempotency

fn default() -> Self

Returns the “default value” for a type.

impl Middleware for Idempotency

fn handle<'life0, 'async_trait>( &'life0 self, req: Request, next: Next, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,