Struct utoipa::openapi::security::ApiKeyValue
source · #[non_exhaustive]pub struct ApiKeyValue {
pub name: String,
pub description: Option<String>,
}
Expand description
Value object for ApiKey
.
Fields (Non-exhaustive)§
This struct is marked as 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§
source§impl ApiKeyValue
impl ApiKeyValue
sourcepub fn new<S: Into<String>>(name: S) -> Self
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");
sourcepub fn with_description<S: Into<String>>(name: S, description: S) -> Self
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§
source§impl Clone for ApiKeyValue
impl Clone for ApiKeyValue
source§fn clone(&self) -> ApiKeyValue
fn clone(&self) -> ApiKeyValue
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<'de> Deserialize<'de> for ApiKeyValue
impl<'de> Deserialize<'de> for ApiKeyValue
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl PartialEq for ApiKeyValue
impl PartialEq for ApiKeyValue
source§fn eq(&self, other: &ApiKeyValue) -> bool
fn eq(&self, other: &ApiKeyValue) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl Serialize for ApiKeyValue
impl Serialize for ApiKeyValue
impl Eq for ApiKeyValue
impl StructuralPartialEq for ApiKeyValue
Auto Trait Implementations§
impl Freeze for ApiKeyValue
impl RefUnwindSafe for ApiKeyValue
impl Send for ApiKeyValue
impl Sync for ApiKeyValue
impl Unpin for ApiKeyValue
impl UnwindSafe for ApiKeyValue
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.