Struct rocket_basicauth::BasicAuth

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

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

Example

#![feature(proc_macro_hygiene, decl_macro)]

#[macro_use] extern crate rocket;

use rocket_basicauth::BasicAuth;

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

fn main() {
    rocket::ignite().mount("/", routes![hello]).launch();
}

Fields

name: String

Required (user)name

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

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

Formats the value using the given formatter.

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

type Error = BasicAuthError

The associated error to be returned if derivation fails.

pub fn from_request(request: &'a Request<'r>) -> Outcome<Self, Self::Error>

Derives an instance of Self from the incoming request metadata.