Struct APIKeySecurityScheme 

pub struct APIKeySecurityScheme {
    pub description: Option<Arc<str>>,
    pub in_: APIKeyLocation,
    pub name: Arc<str>,
}

An API-key-based authentication scheme.

The wire form is OpenAPI’s: a JSON object with type: "apiKey", in: <location>, and name: <parameter>. The in field is OpenAPI’s name for what the proto calls location; the rename is in APIKeySecurityScheme::in_.

Fields

description: Option<Arc<str>>

An optional human-readable description of the scheme.

in_: APIKeyLocation

Where the API key is carried. Wire form is OpenAPI’s in; the Rust field is in_ because in is a reserved keyword.

name: Arc<str>

The name of the header, query parameter, or cookie the key is carried in. REQUIRED, non-empty.

Trait Implementations

impl Clone for APIKeySecurityScheme

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for APIKeySecurityScheme

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for APIKeySecurityScheme

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for APIKeySecurityScheme

impl PartialEq for APIKeySecurityScheme

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for APIKeySecurityScheme

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 APIKeySecurityScheme