Struct rama::http::layer::validate_request::ValidateRequestHeaderLayer

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

Layer that applies ValidateRequestHeader which validates all requests.

See the module docs for an example.

Implementations

impl<C> ValidateRequestHeaderLayer<AuthorizeContext<C>>

pub fn set_allow_anonymous( &mut self, allow_anonymous: bool, ) -> &mut ValidateRequestHeaderLayer<AuthorizeContext<C>>

Allow anonymous requests.

pub fn with_allow_anonymous( self, allow_anonymous: bool, ) -> ValidateRequestHeaderLayer<AuthorizeContext<C>>

Allow anonymous requests.

impl<ResBody> ValidateRequestHeaderLayer<AuthorizeContext<Basic<ResBody>>>

pub fn basic( username: &str, password: &str, ) -> ValidateRequestHeaderLayer<AuthorizeContext<Basic<ResBody>>>

where ResBody: 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<AuthorizeContext<Bearer<ResBody>>>

pub fn bearer( token: &str, ) -> ValidateRequestHeaderLayer<AuthorizeContext<Bearer<ResBody>>>

where ResBody: 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) -> ValidateRequestHeaderLayer<AcceptHeader<ResBody>>

where ResBody: 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 rama_http::layer::validate_request::{AcceptHeader, ValidateRequestHeaderLayer};

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

impl<T> ValidateRequestHeaderLayer<T>

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

Validate requests using a custom validator.

impl<F, A> ValidateRequestHeaderLayer<BoxValidateRequestFn<F, A>>

pub fn custom_fn( validate: F, ) -> ValidateRequestHeaderLayer<BoxValidateRequestFn<F, A>>

Validate requests using a custom validator Fn.

Trait Implementations

impl<T> Clone for ValidateRequestHeaderLayer<T>

where T: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ValidateRequestHeaderLayer<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<S, T> Layer<S> for ValidateRequestHeaderLayer<T>

where T: Clone,

type Service = ValidateRequestHeader<S, T>

The service produced by the layer.

fn layer( &self, inner: S, ) -> <ValidateRequestHeaderLayer<T> as Layer<S>>::Service

Wrap the given service with the middleware, returning a new service.