Struct ApiVersionLayer

pub struct ApiVersionLayer<const N: usize, F> { /* private fields */ }

Axum middleware to rewrite a request such that a version prefix is added to the path. This is based on a set of versions and an optional "x-api-version" custom HTTP header: if no such header is present, the highest version is used. Yet this only applies to requests the URIs of which pass a filter; others are not rewritten.

Paths must not start with a version prefix, e.g. "/v0".

Implementations

impl<const N: usize, F> ApiVersionLayer<N, F>

pub fn new( versions: [u16; N], filter: F, ) -> Result<Self, NewApiVersionLayerError>

Create a new ApiVersionLayer.

The given versions must not be empty and must be strictly monotonically increasing, e.g. [0, 1, 2].

Trait Implementations

impl<const N: usize, F: Clone> Clone for ApiVersionLayer<N, F>

fn clone(&self) -> ApiVersionLayer<N, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize, S, F> Layer<S> for ApiVersionLayer<N, F>

where F: ApiVersionFilter,

type Service = ApiVersion<N, S, F>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.