pub struct BasicAuth(_);
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

Returns client’s user-ID.

Returns client’s password.

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Future that resolves to a Self. Read more
The associated error which can be returned.
Create a Self from request parts asynchronously.
Create a Self from request head asynchronously. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

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

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more