Struct AuthorizationHeaderMiddleware

Source
pub struct AuthorizationHeaderMiddleware { /* private fields */ }
Expand description

AuthorizationHeaderMiddleware

Provided a TokenSource implementation, this middleware will set the Authorization header of the request with the token value obtained from this token source.

The token source is expected to provide a valid token (e.g including renewal), or an error if the token could not be obtained.

§How to use

 use reqwest_middleware::ClientBuilder;
 use token_source::{TokenSource, TokenSourceProvider};
 use std::sync::Arc;
 use reqwest_auth::AuthorizationHeaderMiddleware;
  
 // In real cases you should have a token source provider
 // that provides a token source implementation.
 // Here we are using a simple example with a hardcoded token value.

 // For demonstration purposes.
 #[derive(Debug)]
 struct MyTokenSource {
   pub token: String,
 }

 // For demonstration purposes.
 #[async_trait::async_trait]
 impl TokenSource for MyTokenSource {
   async fn token(&self) -> Result<String, Box<dyn std::error::Error + Send + Sync>> {
      Ok(self.token.clone())
   }
 }

 // For demonstration purposes.
 #[derive(Debug)]
 struct MyTokenProvider {
   pub ts: Arc<MyTokenSource>,
 }

 // For demonstration purposes.
 impl TokenSourceProvider for MyTokenProvider {
   fn token_source(&self) -> Arc<dyn TokenSource> {
     self.ts.clone()
   }
 }

 // For demonstration purposes.
 let ts_provider = MyTokenProvider {
   ts: Arc::new(MyTokenSource {
     token: "Bearer my-token".to_string(),
   }),
 };

 // Create the middleware from the token source
 let auth_middleware = AuthorizationHeaderMiddleware::from(ts_provider.token_source());

 // Create your reqwest client with the middleware
 let client = ClientBuilder::new(reqwest::Client::default())
   // Ideally, the authorization middleware should come last,
   // especially if you are using a retry middleware as well.
   // This way, your retry requests will benefit from the renewals of the token,
   // as long as your token source implementation is able to renew the token.
   .with(auth_middleware)
   .build();

Trait Implementations§

Source§

impl From<Arc<dyn TokenSource>> for AuthorizationHeaderMiddleware

Source§

fn from(ts: Arc<dyn TokenSource>) -> Self

Converts to this type from the input type.
Source§

impl From<Box<dyn TokenSource>> for AuthorizationHeaderMiddleware

Source§

fn from(ts: Box<dyn TokenSource>) -> Self

Converts to this type from the input type.
Source§

impl Middleware for AuthorizationHeaderMiddleware

Source§

fn handle<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, req: Request, extensions: &'life1 mut Extensions, next: Next<'life2>, ) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Invoked with a request before sending it. If you want to continue processing the request, you should explicitly call next.run(req, extensions). Read more

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

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

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::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
Source§

impl<T> ErasedDestructor for T
where T: 'static,