Struct actix_web_httpauth::headers::www_authenticate::basic::Basic

pub struct Basic { /* fields omitted */ }

Challenge for WWW-Authenticate header with HTTP Basic auth scheme, described in RFC 7617

Example

use actix_web_httpauth::headers::www_authenticate::basic::Basic;
use actix_web_httpauth::headers::www_authenticate::WwwAuthenticate;

fn index(_req: HttpRequest) -> HttpResponse {
    let challenge = Basic::with_realm("Restricted area");

    HttpResponse::Unauthorized().set(WwwAuthenticate(challenge)).finish()
}

Methods

impl Basic

pub fn new() -> Basic

Creates new Basic challenge with an empty realm field.

Example

let challenge = Basic::new();

pub fn with_realm<T>(value: T) -> Basic where
    T: Into<Cow<'static, str>>, 

Creates new Basic challenge from the provided realm field value.

Examples

let challenge = Basic::with_realm("Restricted area");

let my_realm = "Earth realm".to_string();
let challenge = Basic::with_realm(my_realm);

Trait Implementations

impl AsRef<Basic> for Config

fn as_ref(&self) -> &Challenge

Performs the conversion.

impl Default for Basic

fn default() -> Basic

Returns the "default value" for a type.

impl Clone for Basic

fn clone(&self) -> Basic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Basic

fn cmp(&self, other: &Basic) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for Basic

impl PartialOrd<Basic> for Basic

fn partial_cmp(&self, other: &Basic) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Basic) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Basic) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Basic) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Basic) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<Basic> for Basic

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for Basic

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

Formats the value using the given formatter.

impl Display for Basic

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

Formats the value using the given formatter.

impl Hash for Basic

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl IntoHeaderValue for Basic

type Error = InvalidHeaderValueBytes

The type returned in the event of a conversion error.

fn try_into(self) -> Result<HeaderValue, Self::Error>

Try to convert value to a Header value.