Struct actix_web_httpauth::extractors::basic::BasicAuth

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

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

impl BasicAuth

pub fn user_id(&self) -> &str

Returns client’s user-ID.

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

Returns client’s password.

Trait Implementations

impl Clone for BasicAuth

fn clone(&self) -> BasicAuth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BasicAuth

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

Formats the value using the given formatter.

impl From<Basic> for BasicAuth

fn from(basic: Basic) -> Self

Converts to this type from the input type.

impl FromRequest for BasicAuth

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

Future that resolves to a Self.

type Error = AuthenticationError<Basic>

The associated error which can be returned.

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.