Struct Basic 

pub struct Basic { /* private fields */ }

Available on crate feature net only.

Basic credentials.

Implementations

impl Basic

pub const fn new(username: NonEmptyStr, password: NonEmptyStr) -> Basic

Creates a new Basic credential.

pub fn clone_with_new_username(&self, username: NonEmptyStr) -> Basic

pub fn clone_with_new_password(&self, password: NonEmptyStr) -> Basic

pub const fn new_insecure(username: NonEmptyStr) -> Basic

Creates a new Basic credential.

pub fn username(&self) -> &str

View the decoded username.

pub fn with_username(self, username: NonEmptyStr) -> Basic

Set or overwrite the username with the given value.

pub fn set_username(&mut self, username: NonEmptyStr) -> &mut Basic

Set or overwrite the username with the given value.

pub fn password(&self) -> Option<&str>

View the decoded password.

If Some(str) is returned it is guaranteed to be non-empty.

pub fn with_password(self, password: NonEmptyStr) -> Basic

Set or overwrite the password with the given value.

pub fn set_password(&mut self, password: NonEmptyStr) -> &mut Basic

Set or overwrite the password with the given value.

pub fn into_authorizer(self) -> StaticAuthorizer<Basic>

Turn itself into a StaticAuthorizer, so it can be used to authorize.

Just a shortcut, QoL.

Trait Implementations

impl<T> AuthoritySync<Basic, T> for Basic

where T: UsernameLabelParser,

fn authorized(&self, ext: &Extensions, credentials: &Basic) -> bool

Returns true if the credentials are authorized, otherwise false.

impl Clone for Basic

fn clone(&self) -> Basic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Credentials for Basic

const SCHEME: &'static str = "Basic"

The scheme identify the format of these credentials.

fn decode(value: &HeaderValue) -> Option<Basic>

Try to decode the credentials from the HeaderValue.

fn encode(&self) -> Option<HeaderValue>

Encode the credentials to a HeaderValue.

impl Debug for Basic

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

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 Eq for Basic

impl Extension for Basic

impl From<Basic> for UserInfo

Construct a UserInfo from a Basic credential by percent-encoding each component into the RFC 3986 §3.2.1 userinfo wire form. The username escapes : (so the first literal : is unambiguously the user/password separator); the password keeps : literal. @, space, and every other non-userinfo byte become %XX, so the result re-parses cleanly through UserInfo::try_from and decodes back to the original credential via UserInfo::to_basic.

Round-trip invariant

Encoding always yields grammar-valid userinfo. The Basic → UserInfo → UserInfo::try_from round-trip holds for exactly the Basic values whose components are free of control bytes (0x00–0x1F / 0x7F): any control byte encodes to a %XX escape that strict parsing then refuses as a pct-decoded-control smuggling vector. Basic::try_from pre-rejects \r / \n / NUL, but the typed constructors (Basic::new, the with_/set_ setters, clone_with_*) do not validate, so any control byte can reach this obscure residual regardless of which entry point built the Basic.

fn from(basic: Basic) -> UserInfo

Converts to this type from the input type.

impl From<Basic> for ProxyCredential

fn from(basic: Basic) -> ProxyCredential

Converts to this type from the input type.

impl From<Basic> for HttpAuthorizer<StaticAuthorizer<Basic>, Basic>

fn from(value: Basic) -> HttpAuthorizer<StaticAuthorizer<Basic>, Basic>

Converts to this type from the input type.

impl From<Basic> for Socks5Auth

fn from(value: Basic) -> Socks5Auth

Converts to this type from the input type.

impl FromStr for Basic

type Err = Box<dyn Error + Sync + Send>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Basic, <Basic as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Basic

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl NetExtension for Basic

impl PartialEq for Basic

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

Constant-time comparison over the credential bytes.

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 TryFrom<&UserInfo> for Basic

fn try_from( value: &UserInfo, ) -> Result<Basic, <Basic as TryFrom<&UserInfo>>::Error>

Parse a UserInfo into HTTP Basic-Auth credentials. Same semantics as UserInfo::to_basic — kept as a TryFrom impl for the standard Basic::try_from(&userinfo)? idiom.

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

impl TryFrom<&str> for Basic

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Basic, <Basic as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<UserInfo> for Basic

fn try_from( value: UserInfo, ) -> Result<Basic, <Basic as TryFrom<UserInfo>>::Error>

Owned-input form of TryFrom<&UserInfo>. Routes through the borrowed impl since Basic::try_from doesn’t need to own the bytes.

type Error = Box<dyn Error + Sync + Send>

The type returned in the event of a conversion error.