Struct KeyAuthBuilder

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

Builder pattern to create a KeyAuth

Fields

hide_credentials: Option<bool>

query: Option<String>

header: Option<String>

Implementations

impl KeyAuthBuilder

pub fn new() -> Self

pub fn with_hide_credentials(self, hide_credentials: bool) -> Self

Apache APISIX will pass the request header or query string that contains the authentication information to the Upstream if hide_credentials is false Otherwise the authentication information will be removed before proxying

pub fn with_query(self, query: impl Into<String>) -> Self

The query string to get the key from Lower priority than header

pub fn with_header(self, header: impl Into<String>) -> Self

The header to get the key from

pub fn build(self) -> Result<KeyAuth, ApisixClientError>

Trait Implementations

impl Clone for KeyAuthBuilder

fn clone(&self) -> KeyAuthBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyAuthBuilder

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

Formats the value using the given formatter.

impl Default for KeyAuthBuilder

fn default() -> KeyAuthBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyAuthBuilder

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 KeyAuthBuilder

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyAuthBuilder