Struct BasicAuth 

pub struct BasicAuth {
    pub username: String,
    pub password: String,
}

HTTP Basic Authentication credentials extractor.

Extracts username and password from the Authorization header using the Basic authentication scheme (RFC 7617). The header value is expected to be Basic <base64(username:password)>.

Example

use fastapi_core::BasicAuth;

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

Error Responses

Returns 401 Unauthorized with WWW-Authenticate: Basic header when:

• Authorization header is missing
• Header doesn’t use Basic scheme
• Base64 decoding fails
• Decoded value doesn’t contain a colon separator

Optional Extraction

Use Option<BasicAuth> to make authentication optional:

async fn maybe_protected(auth: Option<BasicAuth>) -> impl IntoResponse {
    match auth {
        Some(creds) => format!("Hello, {}!", creds.username),
        None => "Hello, anonymous!".to_string(),
    }
}

Fields

username: String

The extracted username.

password: String

The extracted password (may be empty).

Implementations

impl BasicAuth

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

Create new BasicAuth credentials.

pub fn username(&self) -> &str

Get the username.

pub fn password(&self) -> &str

Get the password.

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.