Struct rocket_basicauth::BasicAuth

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

A high-level basic access authentication request guard implementation, containing the username and password used for authentication

Example

#[macro_use] extern crate rocket;

use rocket_basicauth::BasicAuth;

/// Hello route with `auth` request guard, containing a `username` and `password`
#[get("/hello/<age>")]
fn hello(auth: BasicAuth, age: u8) -> String {
    format!("Hello, {} year old named {}!", age, auth.username)
}

#[launch]
fn rocket() -> _ {
    rocket::build().mount("/", routes![hello])
}

Fields

username: String

Required username

password: String

Required password

Implementations

impl BasicAuth

pub fn new<T: Into<String>>(auth_header: T) -> Option<Self>

Creates a new BasicAuth struct/request guard from a given plaintext http auth header or returns a Option::None if invalid

Trait Implementations

impl Debug for BasicAuth

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

Formats the value using the given formatter.

impl<'r> FromRequest<'r> for BasicAuth

type Error = BasicAuthError

The associated error to be returned if derivation fails.

fn from_request<'life0, 'async_trait>(
    request: &'r Request<'life0>
) -> Pin<Box<dyn Future<Output = Outcome<Self, Self::Error>> + Send + 'async_trait>> where
    'r: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Derives an instance of Self from the incoming request metadata.