Struct tower_http::validate_request::ValidateRequestHeaderLayer

pub struct ValidateRequestHeaderLayer<T> { /* private fields */ }

Expand description

Layer that applies ValidateRequestHeader which validates all requests.

See the module docs for an example.

Implementations§

impl<ResBody> ValidateRequestHeaderLayer<Basic<ResBody>>

pub fn basic(username: &str, password: &str) -> Self
where ResBody: Body + Default,

Authorize requests using a username and password pair.

The Authorization header is required to be Basic {credentials} where credentials is base64_encode("{username}:{password}").

Since the username and password is sent in clear text it is recommended to use HTTPS/TLS with this method. However use of HTTPS/TLS is not enforced by this middleware.

impl<ResBody> ValidateRequestHeaderLayer<Bearer<ResBody>>

pub fn bearer(token: &str) -> Self
where ResBody: Body + Default,

Authorize requests using a “bearer token”. Commonly used for OAuth 2.

The Authorization header is required to be Bearer {token}.

§Panics

Panics if the token is not a valid HeaderValue.

impl<ResBody> ValidateRequestHeaderLayer<AcceptHeader<ResBody>>

pub fn accept(value: &str) -> Self
where ResBody: Body + Default,

Validate requests have the required Accept header.

The Accept header is required to be */*, type/* or type/subtype, as configured.

§Panics

Panics if header_value is not in the form: type/subtype, such as application/json See AcceptHeader::new for when this method panics.

§Example

use hyper::Body;
use tower_http::validate_request::{AcceptHeader, ValidateRequestHeaderLayer};

let layer = ValidateRequestHeaderLayer::<AcceptHeader<Body>>::accept("application/json");

impl<T> ValidateRequestHeaderLayer<T>

pub fn custom(validate: T) -> ValidateRequestHeaderLayer<T>

Validate requests using a custom method.

Trait Implementations§

impl<T: Clone> Clone for ValidateRequestHeaderLayer<T>

fn clone(&self) -> ValidateRequestHeaderLayer<T>

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for ValidateRequestHeaderLayer<T>

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

Formats the value using the given formatter. Read more

impl<S, T> Layer<S> for ValidateRequestHeaderLayer<T>
where T: Clone,

type Service = ValidateRequestHeader<S, T>

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.

Auto Trait Implementations§

impl<T> Freeze for ValidateRequestHeaderLayer<T>
where T: Freeze,

impl<T> RefUnwindSafe for ValidateRequestHeaderLayer<T>
where T: RefUnwindSafe,

impl<T> Send for ValidateRequestHeaderLayer<T>
where T: Send,

impl<T> Sync for ValidateRequestHeaderLayer<T>
where T: Sync,

impl<T> Unpin for ValidateRequestHeaderLayer<T>
where T: Unpin,

impl<T> UnwindSafe for ValidateRequestHeaderLayer<T>
where T: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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