# Struct actix_web_httpauth::extractors::bearer::BearerAuth

source ·

    pub struct BearerAuth(/* private fields */);

Expand description

Extractor for HTTP Bearer auth

## §Examples

    use actix_web_httpauth::extractors::bearer::BearerAuth;

    async fn index(auth: BearerAuth) -> String {
        format!("Hello, user with token {}!", auth.token())
    }

If authentication fails, this extractor fetches the `Config` instance from the [app data] in order to properly form the `WWW-Authenticate` response header.

## §Examples

    use actix_web::{web, App};
    use actix_web_httpauth::extractors::bearer::{self, BearerAuth};

    async fn index(auth: BearerAuth) -> String {
        format!("Hello, {}!", auth.token())
    }

    App::new()
        .app_data(
            bearer::Config::default()
                .realm("Restricted area")
                .scope("email photo"),
        )
        .service(web::resource("/index.html").route(web::get().to(index)));

## Implementations§

source§

### impl BearerAuth

source

#### pub fn token(&self) -> &str

Returns bearer token provided by client.

## Trait Implementations§

source§

### impl Clone for BearerAuth

source§

#### fn clone(&self) -> BearerAuth

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 BearerAuth

source§

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

Formats the value using the given formatter. Read more
source§

### impl FromRequest for BearerAuth

§

#### type Future = Ready<Result<BearerAuth, <BearerAuth as FromRequest>::Error>>

Future that resolves to a `Self`. Read more
§

#### type Error = AuthenticationError<Bearer>

The associated error which can be returned.
source§

#### fn from_request( req: &HttpRequest, _payload: &mut Payload ) -> <Self as FromRequest>::Future

Create a `Self` from request parts asynchronously.
§

#### fn extract(req: &HttpRequest) -> Self::Future

Create a `Self` from request head asynchronously. Read more

## Auto Trait Implementations§

§

### impl RefUnwindSafe for BearerAuth

§

### impl Send for BearerAuth

§

### impl Sync for BearerAuth

§

### impl Unpin for BearerAuth

§

### impl UnwindSafe for BearerAuth

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

§

### impl<T> Instrument for T

§

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

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### 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> Same for T

§

#### type Output = T

Should always be `Self`
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)

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

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

§

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

§

#### 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.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### 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
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more