dropshot

Struct ClientSpecifiesVersionInHeader

Source 
pub struct ClientSpecifiesVersionInHeader { /* private fields */ }
Expand description

Implementation of DynamicVersionPolicy where the client must specify a specific semver in a specific header and we always use whatever they requested

An incoming request will be rejected with a 400-level error if:

  • the header value cannot be parsed as a semver, or
  • the requested version is newer than max_version (see ClientSpecifiesVersionInHeader::new(), which implies that the client is trying to use a newer version of the API than this server supports.

If you need anything more flexible (e.g., validating the provided version against a fixed set of supported versions), you’ll want to impl DynamicVersionPolicy yourself.

Implementations§

Source§

impl ClientSpecifiesVersionInHeader

Source

pub fn new( name: HeaderName, max_version: Version, ) -> ClientSpecifiesVersionInHeader

Make a new ClientSpecifiesVersionInHeader policy

Arguments:

  • name: name of the header that the client will use to specify the version
  • max_version: the maximum version of the API that this server supports. Requests for a version newer than this will be rejected with a 400-level error.

Trait Implementations§

Source§

impl Debug for ClientSpecifiesVersionInHeader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl DynamicVersionPolicy for ClientSpecifiesVersionInHeader

Source§

fn request_extract_version( &self, request: &Request<Body>, _log: &Logger, ) -> Result<Version, HttpError>

Given a request, determine the API version to use to route the request to the appropriate handler Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> SendSyncUnwindSafe for T
where T: Send + Sync + UnwindSafe + ?Sized,

Source§

impl<T> ServerContext for T
where T: 'static + Send + Sync,