Struct RequestId 

pub struct RequestId(/* private fields */);

A request identifier selected by the configured request-ID policy.

Values created through parse, FromStr, or TryFrom satisfy the baseline grammar: 1 to MAX_LEN ASCII URI-unreserved bytes. Middleware can also construct this type for one native-safe caller value admitted by a custom validator; such a value is not guaranteed to satisfy the baseline grammar.

Implementations

impl RequestId

pub const MAX_LEN: usize = 128

Maximum request-ID length accepted by the baseline parser, in bytes.

A caller value admitted by a custom middleware validator can be longer.

pub fn parse(value: &str) -> Result<Self, InvalidRequestId>

Parses and validates a request identifier.

Errors

Returns the first deterministic baseline validation failure without retaining or echoing the rejected value.

Examples

use axum_observability::RequestId;

let request_id = RequestId::parse("request-42")?;
assert_eq!(request_id.as_str(), "request-42");

pub fn as_str(&self) -> &str

Returns the validated identifier.

Trait Implementations

impl AsRef<str> for RequestId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for RequestId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestId

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

Formats the value using the given formatter.

impl Display for RequestId

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

Formats the value using the given formatter.

impl Eq for RequestId

impl FromStr for RequestId

type Err = InvalidRequestId

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for RequestId

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RequestId

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for RequestId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RequestId

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for RequestId

impl TryFrom<&str> for RequestId

type Error = InvalidRequestId

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for RequestId

type Error = InvalidRequestId

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.