Struct VersionHeader 

pub struct VersionHeader { /* private fields */ }

Read the API version from a header.

App::new()?.middleware(
    VersionHeader::new("X-API-Version")
        .default("2")
        .allow(["1", "2"]),
)

A vendor media type in Accept — application/vnd.example.v2+json — is read as well when VersionHeader::from_accept names the vendor prefix. A request naming a version that is not allowed is a 400 that lists what is, rather than a silent fall-through to the default: a client that asked for v3 and got v1’s shape would be worse off than one that got an error.

Implementations

impl VersionHeader

pub fn new(header: &str) -> Self

pub fn default(self, version: &str) -> Self

The version to assume when the client names none.

Stripe pins this per account; most APIs pin it to the oldest still supported, so a client written against it keeps working unchanged.

pub fn from_accept(self, vendor: &str) -> Self

Also accept Accept: application/vnd.{vendor}.v{N}+json.

pub fn allow<I, S>(self, versions: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

The versions that exist. Anything else is a 400.

Trait Implementations

impl Clone for VersionHeader

fn clone(&self) -> VersionHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VersionHeader

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

Formats the value using the given formatter.

impl Middleware for VersionHeader

fn handle(&self, request: Request, next: Next) -> BoxFuture<Response>