# Struct actix_web_httpauth::extractors::basic::BasicAuth

source ·

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

Expand description

Extractor for HTTP Basic auth.

## §Examples

    use actix_web_httpauth::extractors::basic::BasicAuth;

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

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::basic::{self, BasicAuth};

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

    App::new()
        .app_data(basic::Config::default().realm("Restricted area"))
        .service(web::resource("/index.html").route(web::get().to(index)));

## Implementations§

source §

### impl BasicAuth

source

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

Returns client’s user-ID.

source

#### pub fn password(&self) -> Option<&str>

Returns client’s password.

## Trait Implementations§

source §

### impl Clone for BasicAuth

source §

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

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 BasicAuth

source §

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

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

### impl From<Basic> for BasicAuth

source §

#### fn from(basic: Basic) -> Self

Converts to this type from the input type.
source §

### impl FromRequest for BasicAuth

§

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

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

#### type Error = AuthenticationError<Basic>

The associated error which can be returned.
source §

#### fn from_request( req: &HttpRequest, _: &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 BasicAuth

§

### impl Send for BasicAuth

§

### impl Sync for BasicAuth

§

### impl Unpin for BasicAuth

§

### impl UnwindSafe for BasicAuth

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