Struct tower_http::auth::AddAuthorizationLayer

source · [−]

pub struct AddAuthorizationLayer { /* private fields */ }

This is supported on crate feature auth only.

Expand description

Layer that applies AddAuthorization which adds authorization to 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 AddAuthorizationLayer

source

pub fn basic(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(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 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 Clone for AddAuthorizationLayer

source

fn clone(&self) -> AddAuthorizationLayer

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 Debug for AddAuthorizationLayer

source

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

Formats the value using the given formatter. Read more

source

impl<S> Layer<S> for AddAuthorizationLayer

type Service = AddAuthorization<S>

The wrapped service

source

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. Read more

Auto Trait Implementations

impl RefUnwindSafe for AddAuthorizationLayer

impl Send for AddAuthorizationLayer

impl Sync for AddAuthorizationLayer

impl Unpin for AddAuthorizationLayer

impl UnwindSafe for AddAuthorizationLayer

Blanket Implementations

source

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

source

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

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

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

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

source

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

source

fn and<P, B, E>(self, other: 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

fn or<P, B, E>(self, other: 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

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

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

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::AddAuthorizationLayer

Implementations

impl AddAuthorizationLayer

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

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

Panics

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

Trait Implementations

impl Clone for AddAuthorizationLayer

fn clone(&self) -> AddAuthorizationLayer

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

impl Debug for AddAuthorizationLayer

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

impl<S> Layer<S> for AddAuthorizationLayer

type Service = AddAuthorization<S>

fn layer(&self, inner: S) -> Self::Service

Auto Trait Implementations

impl RefUnwindSafe for AddAuthorizationLayer

impl Send for AddAuthorizationLayer

impl Sync for AddAuthorizationLayer

impl Unpin for AddAuthorizationLayer

impl UnwindSafe for AddAuthorizationLayer

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

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

fn into(self) -> U

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

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

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

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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<T> PolicyExt for T where
T: ?Sized,

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

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

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