Struct tower_http::auth::AddAuthorization

source · [−]

pub struct AddAuthorization<S> { /* private fields */ }

This is supported on crate feature auth only.

Expand description

Middleware that adds authorization all requests using the Authorization header.

See the module docs for an example.

You can also use SetRequestHeader if you have a use case that isn’t supported by this middleware.

Implementations

source

impl<S> AddAuthorization<S>

source

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

Authorize requests using a username and password pair.

The Authorization header will be set to 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.

source

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

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

The Authorization header will be set to Bearer {token}.

Panics

Panics if the token is not a valid HeaderValue.

source

pub fn get_ref(&self) -> &S

Gets a reference to the underlying service.

source

pub fn get_mut(&mut self) -> &mut S

Gets a mutable reference to the underlying service.

source

pub fn into_inner(self) -> S

Consumes self, returning the underlying service.

source

pub fn as_sensitive(self, sensitive: bool) -> Self

Mark the header as sensitive.

This can for example be used to hide the header value from logs.

Trait Implementations

source

impl<S: Clone> Clone for AddAuthorization<S>

source

fn clone(&self) -> AddAuthorization<S>

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

source

impl<S: Debug> Debug for AddAuthorization<S>

source

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

Formats the value using the given formatter. Read more

source

impl<S, ReqBody> Service<Request<ReqBody>> for AddAuthorization<S> where
S: Service<Request<ReqBody>>,

type Response = S::Response

Responses given by the service.

type Error = S::Error

Errors produced by the service.

type Future = S::Future

The future response value.

source

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

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

source

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

Process the request and return the response asynchronously. Read more

Auto Trait Implementations

impl<S> RefUnwindSafe for AddAuthorization<S> where
S: RefUnwindSafe,

impl<S> Send for AddAuthorization<S> where
S: Send,

impl<S> Sync for AddAuthorization<S> where
S: Sync,

impl<S> Unpin for AddAuthorization<S> where
S: Unpin,

impl<S> UnwindSafe for AddAuthorization<S> where
S: UnwindSafe,

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

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 for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<M, S, Target, Request> MakeService<Target, Request> for M where
M: Service<Target, Response = S>,
S: Service<Request>,

type Response = <S as Service<Request>>::Response

Responses given by the service

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

Errors produced by the service

type Service = S

The Service value created by this factory

type MakeError = <M as Service<Target>>::Error

Errors produced while building a service.

type Future = <M as Service<Target>>::Future

The future of the Service instance.

source

pub fn poll_ready(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), <M as MakeService<Target, Request>>::MakeError>>

Returns Poll::Ready when the factory is able to create more services. Read more

source

pub fn make_service(
&mut self,
target: Target
) -> <M as MakeService<Target, Request>>::Future

Create and return a new service value asynchronously.

source

fn into_service(self) -> IntoService<Self, Request>

Consume this MakeService and convert it into a Service. Read more

source

fn as_service(&mut self) -> AsService<'_, Self, Request>

Convert this MakeService into a Service without consuming the original MakeService. Read more

source

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

source

pub fn and<P, B, E>(Self, P) -> And<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

This is supported on crate feature follow-redirect only.

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

source

pub fn or<P, B, E>(Self, P) -> Or<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

This is supported on crate feature follow-redirect only.

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

source

impl<T, Request> ServiceExt<Request> for T where
T: Service<Request> + ?Sized,

source

fn ready(&mut self) -> Ready<'_, Self, Request>

Yields a mutable reference to the service when it is ready to accept a request.

source

fn ready_and(&mut self) -> Ready<'_, Self, Request>

👎 Deprecated since 0.4.6:

please use the ServiceExt::ready method instead

Yields a mutable reference to the service when it is ready to accept a request.

source

fn ready_oneshot(self) -> ReadyOneshot<Self, Request>

Yields the service when it is ready to accept a request.

source

fn oneshot(self, req: Request) -> Oneshot<Self, Request>

Consume this Service, calling with the providing request once it is ready.

source

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
S: Stream<Item = Request>,
Self::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,

Process all requests from the given Stream, and produce a Stream of their responses. Read more

source

fn and_then<F>(self, f: F) -> AndThen<Self, F> where
F: Clone,

Executes a new future after this service’s future resolves. This does not alter the behaviour of the poll_ready method. Read more

source

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where
F: FnOnce(Self::Response) -> Response + Clone,

Maps this service’s response value to a different value. This does not alter the behaviour of the poll_ready method. Read more

source

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> Error + Clone,

Maps this service’s error value to a different value. This does not alter the behaviour of the poll_ready method. Read more

source

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

Maps this service’s result type (Result<Self::Response, Self::Error>) to a different value, regardless of whether the future succeeds or fails. Read more

source

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where
F: FnMut(NewRequest) -> Request,

Composes a function in front of the service. Read more

source

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where
 Error: From<Self::Error>,
 F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
 Fut: Future<Output = Result<Response, Error>>,

Composes an asynchronous function after this service. Read more

source

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where
 F: FnMut(Self::Future) -> Fut,
 Error: From<Self::Error>,
 Fut: Future<Output = Result<Response, Error>>,

Composes a function that transforms futures produced by the service. Read more

source

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error> where
 Self: 'static + Send,
 Self::Future: 'static,
 Self::Future: Send,

Convert the service into a Service + Send trait object. Read more

source

fn boxed_clone(self) -> BoxCloneService<Request, Self::Response, Self::Error> where
 Self: 'static + Clone + Send,
 Self::Future: 'static,
 Self::Future: Send,

Convert the service into a Service + Clone + Send trait object. Read more

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::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

Struct tower_http::auth::AddAuthorization

Implementations

impl<S> AddAuthorization<S>

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

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

Panics

pub fn get_ref(&self) -> &S

pub fn get_mut(&mut self) -> &mut S

pub fn into_inner(self) -> S

pub fn as_sensitive(self, sensitive: bool) -> Self

Trait Implementations

impl<S: Clone> Clone for AddAuthorization<S>

fn clone(&self) -> AddAuthorization<S>

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

impl<S: Debug> Debug for AddAuthorization<S>

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

impl<S, ReqBody> Service<Request<ReqBody>> for AddAuthorization<S> where S: Service<Request<ReqBody>>,

type Response = S::Response

type Error = S::Error

type Future = S::Future

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

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

Auto Trait Implementations

impl<S> RefUnwindSafe for AddAuthorization<S> where S: RefUnwindSafe,

impl<S> Send for AddAuthorization<S> where S: Send,

impl<S> Sync for AddAuthorization<S> where S: Sync,

impl<S> Unpin for AddAuthorization<S> where S: Unpin,

impl<S> UnwindSafe for AddAuthorization<S> where S: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<M, S, Target, Request> MakeService<Target, Request> for M where M: Service<Target, Response = S>, S: Service<Request>,

type Response = <S as Service<Request>>::Response

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

type Service = S

type MakeError = <M as Service<Target>>::Error

type Future = <M as Service<Target>>::Future

pub fn poll_ready( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), <M as MakeService<Target, Request>>::MakeError>>

pub fn make_service( &mut self, target: Target) -> <M as MakeService<Target, Request>>::Future

fn into_service(self) -> IntoService<Self, Request>

fn as_service(&mut self) -> AsService<'_, Self, Request>

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

pub fn and<P, B, E>(Self, P) -> And<T, P> where T: Policy<B, E>, P: Policy<B, E>,

pub fn or<P, B, E>(Self, P) -> Or<T, P> where T: Policy<B, E>, P: Policy<B, E>,

impl<T, Request> ServiceExt<Request> for T where T: Service<Request> + ?Sized,

fn ready(&mut self) -> Ready<'_, Self, Request>

fn ready_and(&mut self) -> Ready<'_, Self, Request>

fn ready_oneshot(self) -> ReadyOneshot<Self, Request>

fn oneshot(self, req: Request) -> Oneshot<Self, Request>

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where S: Stream<Item = Request>, Self::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,

fn and_then<F>(self, f: F) -> AndThen<Self, F> where F: Clone,

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where F: FnOnce(Self::Response) -> Response + Clone,

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where F: FnOnce(Self::Error) -> Error + Clone,

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where F: FnMut(NewRequest) -> Request,

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone, Fut: Future<Output = Result<Response, Error>>,

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where F: FnMut(Self::Future) -> Fut, Error: From<Self::Error>, Fut: Future<Output = Result<Response, Error>>,

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error> where Self: 'static + Send, Self::Future: 'static, Self::Future: Send,

fn boxed_clone(self) -> BoxCloneService<Request, Self::Response, Self::Error> where Self: 'static + Clone + Send, Self::Future: 'static, Self::Future: Send,

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<S, ReqBody> Service<Request<ReqBody>> for AddAuthorization<S> where
S: Service<Request<ReqBody>>,

impl<S> RefUnwindSafe for AddAuthorization<S> where
S: RefUnwindSafe,

impl<S> Send for AddAuthorization<S> where
S: Send,

impl<S> Sync for AddAuthorization<S> where
S: Sync,

impl<S> Unpin for AddAuthorization<S> where
S: Unpin,

impl<S> UnwindSafe for AddAuthorization<S> where
S: UnwindSafe,

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

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

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

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

impl<M, S, Target, Request> MakeService<Target, Request> for M where
M: Service<Target, Response = S>,
S: Service<Request>,

pub fn poll_ready(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), <M as MakeService<Target, Request>>::MakeError>>

pub fn make_service(
&mut self,
target: Target
) -> <M as MakeService<Target, Request>>::Future

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

pub fn and<P, B, E>(Self, P) -> And<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

pub fn or<P, B, E>(Self, P) -> Or<T, P> where
T: Policy<B, E>,
P: Policy<B, E>,

impl<T, Request> ServiceExt<Request> for T where
T: Service<Request> + ?Sized,

fn call_all<S>(self, reqs: S) -> CallAll<Self, S> where
S: Stream<Item = Request>,
Self::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,

fn and_then<F>(self, f: F) -> AndThen<Self, F> where
F: Clone,

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F> where
F: FnOnce(Self::Response) -> Response + Clone,

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> Error + Clone,

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F> where
F: FnMut(NewRequest) -> Request,

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F> where
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
Fut: Future<Output = Result<Response, Error>>,

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F> where
F: FnMut(Self::Future) -> Fut,
Error: From<Self::Error>,
Fut: Future<Output = Result<Response, Error>>,

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error> where
Self: 'static + Send,
Self::Future: 'static,
Self::Future: Send,

fn boxed_clone(self) -> BoxCloneService<Request, Self::Response, Self::Error> where
Self: 'static + Clone + Send,
Self::Future: 'static,
Self::Future: Send,

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

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

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

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