#[non_exhaustive]pub struct Http {
pub scheme: HttpAuthScheme,
pub bearer_format: Option<String>,
pub description: Option<String>,
}
Expand description
Http authentication SecurityScheme
builder.
Methods can be chained to configure bearer_format or to add description.
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.scheme: HttpAuthScheme
Http authorization scheme in HTTP Authorization
header value.
bearer_format: Option<String>
Optional hint to client how the bearer token is formatted. Valid only with HttpAuthScheme::Bearer
.
description: Option<String>
Optional description of Http
SecurityScheme
supporting markdown syntax.
Implementations§
source§impl Http
impl Http
sourcepub fn new(scheme: HttpAuthScheme) -> Self
pub fn new(scheme: HttpAuthScheme) -> Self
Create new http authentication security schema.
Accepts one argument which defines the scheme of the http authentication.
§Examples
Create http security schema with basic authentication.
SecurityScheme::Http(Http::new(HttpAuthScheme::Basic));
Trait Implementations§
source§impl<'de> Deserialize<'de> for Http
impl<'de> Deserialize<'de> for Http
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 From<Http> for HttpBuilder
impl From<Http> for HttpBuilder
source§impl From<HttpBuilder> for Http
impl From<HttpBuilder> for Http
source§fn from(value: HttpBuilder) -> Self
fn from(value: HttpBuilder) -> Self
Converts to this type from the input type.
source§impl PartialEq for Http
impl PartialEq for Http
impl Eq for Http
impl StructuralPartialEq for Http
Auto Trait Implementations§
impl Freeze for Http
impl RefUnwindSafe for Http
impl Send for Http
impl Sync for Http
impl Unpin for Http
impl UnwindSafe for Http
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.