Struct utoipa::openapi::security::ApiKeyValue

#[non_exhaustive]
pub struct ApiKeyValue {
    pub name: String,
    pub description: Option<String>,
}

Value object for ApiKey.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Name of the ApiKey parameter.

description: Option<String>

Description of the the ApiKey SecurityScheme. Supports markdown syntax.

Implementations

impl ApiKeyValue

pub fn new<S: Into<String>>(name: S) -> Self

Constructs new api key value.

Examples

Create new api key security schema with name api_key.

let api_key = ApiKeyValue::new("api_key");

pub fn with_description<S: Into<String>>(name: S, description: S) -> Self

Construct a new api key with optional description supporting markdown syntax.

Examples

Create new api key security schema with name api_key with description.

let api_key = ApiKeyValue::with_description("api_key", "my api_key token");

Trait Implementations

impl Clone for ApiKeyValue

fn clone(&self) -> ApiKeyValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for ApiKeyValue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiKeyValue

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

Serialize this value into the given Serde serializer.