Struct BasicAuth 

pub struct BasicAuth { /* private fields */ }

Extracts HTTP Basic authentication credentials from the Authorization header.

This implements the HTTP Basic authentication scheme as defined in RFC 7617. The Authorization header should contain Basic <base64(username:password)>.

Example

use fastapi_core::BasicAuth;

async fn protected_route(auth: BasicAuth) -> impl IntoResponse {
    format!("Hello, {}!", auth.username())
}

Error Handling

When credentials are missing or invalid, a 401 Unauthorized response is returned with a WWW-Authenticate: Basic header, following RFC 7617.

Optional Extraction

Wrap in Option to make authentication optional:

async fn maybe_auth(auth: Option<BasicAuth>) -> impl IntoResponse {
    match auth {
        Some(a) => format!("Hello, {}!", a.username()),
        None => "Anonymous access".to_string(),
    }
}

OpenAPI

This extractor generates the following OpenAPI security scheme:

securitySchemes:
  BasicAuth:
    type: http
    scheme: basic

Implementations

impl BasicAuth

pub fn new(username: impl Into<String>, password: impl Into<String>) -> Self

Create a new BasicAuth with the given username and password.

pub fn username(&self) -> &str

Get the username.

pub fn password(&self) -> &str

Get the password.

pub fn into_credentials(self) -> (String, String)

Consume self and return the username and password as a tuple.

Trait Implementations

impl Clone for BasicAuth

fn clone(&self) -> BasicAuth

Returns a duplicate 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 FromRequest for BasicAuth

type Error = BasicAuthError

Error type when extraction fails.

async fn from_request( _ctx: &RequestContext, req: &mut Request, ) -> Result<Self, Self::Error>

Extract a value from the request.

impl PartialEq for BasicAuth

fn eq(&self, other: &BasicAuth) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BasicAuth

impl StructuralPartialEq for BasicAuth