Struct KeyAuth

pub struct KeyAuth {
    pub hide_credentials: Option<bool>,
    pub query: Option<String>,
    pub header: Option<String>,
}

The key-auth Plugin is used to add an authentication key (API key) to a Route or a Service. This works well with a Consumer. Consumers of the API can then add their key to the query string or the header to authenticate their requests. Documentation

Fields

hide_credentials: Option<bool>

query: Option<String>

header: Option<String>

Trait Implementations

impl Clone for KeyAuth

fn clone(&self) -> KeyAuth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyAuth

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

Formats the value using the given formatter.

impl Default for KeyAuth

fn default() -> KeyAuth

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyAuth

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<KeyAuth> for KeyAuthBuilder

fn from(item: KeyAuth) -> Self

Converts to this type from the input type.

impl PartialEq for KeyAuth

fn eq(&self, other: &KeyAuth) -> 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 KeyAuth

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Plugin for KeyAuth

impl StructuralPartialEq for KeyAuth