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
sourceimpl 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
sourceimpl Clone for ApiKeyValue
impl Clone for ApiKeyValue
sourcefn clone(&self) -> ApiKeyValue
fn clone(&self) -> ApiKeyValue
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<'de> Deserialize<'de> for ApiKeyValue
impl<'de> Deserialize<'de> for ApiKeyValue
sourcefn 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
sourceimpl Serialize for ApiKeyValue
impl Serialize for ApiKeyValue
Auto Trait Implementations
impl RefUnwindSafe for ApiKeyValue
impl Send for ApiKeyValue
impl Sync for ApiKeyValue
impl Unpin for ApiKeyValue
impl UnwindSafe for ApiKeyValue
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more