Enum vector::http::Auth

pub enum Auth {
    Basic {
        user: String,
        password: SensitiveString,
    },
    Bearer {
        token: SensitiveString,
    },
}

Configuration of the authentication strategy for HTTP requests.

HTTP authentication should be used with HTTPS only, as the authentication credentials are passed as an HTTP header without any additional encryption beyond what is provided by the transport itself.

Variants

Basic

Basic authentication.

The username and password are concatenated and encoded via base64.

Fields

user: String

The basic authentication username.

password: SensitiveString

The basic authentication password.

Bearer

Bearer authentication.

The bearer token value (OAuth2, JWT, etc.) is passed as-is.

Fields

token: SensitiveString

The bearer authentication token.

Implementations

impl Auth

pub fn apply<B>(&self, req: &mut Request<B>)

pub fn apply_builder(&self, builder: Builder) -> Builder

pub fn apply_headers_map(&self, map: &mut HeaderMap)

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for Auth

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for Auth

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Auth

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Auth

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

Tests for self and other values to be equal, and is used by ==.

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 Serialize for Auth

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for Auth

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.

impl Eq for Auth

impl StructuralPartialEq for Auth