Struct tower_http::validate_request::ValidateRequestHeader

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

Available on crate feature validate-request only.

Middleware that validates requests.

See the module docs for an example.

Implementations

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

pub fn basic(inner: S, username: &str, value: &str) -> Self

where ResBody: Body + Default,

Available on crate feature auth only.

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, Bearer<ResBody>>

pub fn bearer(inner: S, token: &str) -> Self

where ResBody: Body + Default,

Available on crate feature auth only.

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 get_mut(&mut self) -> &mut S

Gets a mutable 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) -> 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

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 method.

Trait Implementations

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

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: Debug, T: Debug> Debug for ValidateRequestHeader<S, T>

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

Formats the value using the given formatter.

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

where V: ValidateRequest<ReqBody, ResponseBody = ResBody>, S: Service<Request<ReqBody>, Response = Response<ResBody>>,

type Response = Response<ResBody>

Responses given by the service.

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

Errors produced by the service.

type Future = ResponseFuture<<S as Service<Request<ReqBody>>>::Future, ResBody>

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: Request<ReqBody>) -> Self::Future

Process the request and return the response asynchronously.