Struct IdempotencyKeyRule 

pub struct IdempotencyKeyRule { /* private fields */ }

Length bounds for Idempotency-Key values on one route.

A key is min_bytes..=max_bytes bytes of visible ASCII (0x21..=0x7E). The key is opaque: quotes are part of the key, and nothing is trimmed beyond what the HTTP stack removes.

Implementations

impl IdempotencyKeyRule

pub const fn new(min_bytes: usize, max_bytes: usize) -> Self

Creates a rule for keys of min_bytes..=max_bytes bytes.

Panics

Panics unless 1 <= min_bytes <= max_bytes <= MAX_IDEMPOTENCY_KEY_BYTES. In a const item the panic is a compile error. Use IdempotencyKeyRule::try_new for bounds read at runtime.

pub const fn try_new( min_bytes: usize, max_bytes: usize, ) -> Result<Self, InvalidIdempotencyKeyRule>

Creates a rule from bounds read at runtime.

pub const fn min_bytes(&self) -> usize

Returns the shortest accepted key, in bytes.

pub const fn max_bytes(&self) -> usize

Returns the longest accepted key, in bytes.

pub fn parse<'h>( &self, value: &'h HeaderValue, ) -> Result<IdempotencyKey<'h>, InvalidIdempotencyKey>

Parses one Idempotency-Key field value.

pub fn required<'h>( &self, headers: &'h HeaderMap, ) -> Result<IdempotencyKey<'h>, IdempotencyError>

Reads the key from a route that requires Idempotency-Key.

A missing header returns IdempotencyError::Required.

pub fn optional<'h>( &self, headers: &'h HeaderMap, ) -> Result<Option<IdempotencyKey<'h>>, IdempotencyError>

Reads the key from a route where Idempotency-Key is optional.

A missing header returns Ok(None), which runs the mutation without a replay record.

Trait Implementations

impl Clone for IdempotencyKeyRule

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for IdempotencyKeyRule

impl Debug for IdempotencyKeyRule

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

Formats the value using the given formatter.

impl Eq for IdempotencyKeyRule

impl PartialEq for IdempotencyKeyRule

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IdempotencyKeyRule