Struct rama::http::layer::validate_request::ValidateRequestHeader

pub struct ValidateRequestHeader<S, T> { /* private fields */ }

Middleware that validates requests.

See the module docs for an example.

Implementations

impl<S, C> ValidateRequestHeader<S, AuthorizeContext<C>>

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

Allow anonymous requests.

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

Allow anonymous requests.

impl<S, ResBody> ValidateRequestHeader<S, AuthorizeContext<Basic<ResBody>>>

pub fn basic( inner: S, username: &str, value: &str, ) -> ValidateRequestHeader<S, 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<S, ResBody> ValidateRequestHeader<S, AuthorizeContext<Bearer<ResBody>>>

pub fn bearer( inner: S, token: &str, ) -> ValidateRequestHeader<S, 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<S, T> ValidateRequestHeader<S, T>

pub fn get_ref(&self) -> &S

Gets a reference to the underlying service.

pub fn into_inner(self) -> S

Consumes self, returning the underlying service.

impl<S, ResBody> ValidateRequestHeader<S, AcceptHeader<ResBody>>

pub fn accept( inner: S, value: &str, ) -> ValidateRequestHeader<S, 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

See AcceptHeader::new for when this method panics.

impl<S, T> ValidateRequestHeader<S, T>

pub fn custom(inner: S, validate: T) -> ValidateRequestHeader<S, T>

Validate requests using a custom validator.

impl<S, F, A> ValidateRequestHeader<S, BoxValidateRequestFn<F, A>>

pub fn custom_fn( inner: S, validate: F, ) -> ValidateRequestHeader<S, BoxValidateRequestFn<F, A>>

Validate requests using a custom validator Fn.

Trait Implementations

impl<S, T> Clone for ValidateRequestHeader<S, T>

where S: Clone, T: Clone,

fn clone(&self) -> ValidateRequestHeader<S, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, T> Debug for ValidateRequestHeader<S, T>

where S: Debug, T: Debug,

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

Formats the value using the given formatter.

impl<ReqBody, ResBody, State, S, V> Service<State, Request<ReqBody>> for ValidateRequestHeader<S, V>

where ReqBody: Send + 'static, ResBody: Send + 'static, State: Clone + Send + Sync + 'static, V: ValidateRequest<State, ReqBody, ResponseBody = ResBody>, S: Service<State, Request<ReqBody>, Response = Response<ResBody>>,

type Response = Response<ResBody>

The type of response returned by the service.

type Error = <S as Service<State, Request<ReqBody>>>::Error

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<ReqBody>, ) -> Result<<ValidateRequestHeader<S, V> as Service<State, Request<ReqBody>>>::Response, <ValidateRequestHeader<S, V> as Service<State, Request<ReqBody>>>::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.