Struct ServerRequestId

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

A unique identifier generated for each incoming request.

It is a TypeId. The prefix is always sri, followed by an underscore and UUIDv7 in base32 encoding. For example:

 sri_2x4y6z8a0b1c2d3e4f5g6h7j8k
 └─┘ └────────────────────────┘
prefix    uuid suffix (base32)

Example

use http::{HeaderName, HeaderValue};
use pavex::response::Response;
use pavex::telemetry::ServerRequestId;

pub async fn request_handler(request_id: ServerRequestId) -> Response {
    // Add the request id as a header on the outgoing response
    Response::ok()
        .insert_header(
            HeaderName::from_static("X-Request-Id"),
            request_id.header_value()
        )
}

Implementations

impl ServerRequestId

pub fn generate() -> Self

The default constructor for ServerRequestId.

It generates a new request id using a UUID v7, with a random number and the current (UNIX) timestamp.

pub fn inner(&self) -> Uuid

Access the underlying UUID.

pub fn header_value(&self) -> HeaderValue

Return a hyphenated representation of ServerRequestId to be used as a HeaderValue.

impl ServerRequestId

Registration helpers.

pub fn register(bp: &mut Blueprint) -> RegisteredConstructor<'_>

Register the default constructor for ServerRequestId with a Blueprint.

pub fn default_constructor() -> Constructor

The default constructor for ServerRequestId.

Trait Implementations

impl Clone for ServerRequestId

fn clone(&self) -> ServerRequestId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerRequestId

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

Formats the value using the given formatter.

impl Display for ServerRequestId

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

Formats the value using the given formatter.

impl From<Uuid> for ServerRequestId

fn from(value: Uuid) -> Self

Converts to this type from the input type.

impl Hash for ServerRequestId

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 ServerRequestId

fn cmp(&self, other: &ServerRequestId) -> 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.

impl PartialEq for ServerRequestId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ServerRequestId

fn partial_cmp(&self, other: &ServerRequestId) -> 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 Copy for ServerRequestId

impl Eq for ServerRequestId

impl StructuralPartialEq for ServerRequestId