#[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
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));
Sourcepub fn scheme(self, scheme: HttpAuthScheme) -> Self
pub fn scheme(self, scheme: HttpAuthScheme) -> Self
Add or change http authentication scheme used.
Sourcepub fn bearer_format<S: Into<String>>(self, bearer_format: S) -> Self
pub fn bearer_format<S: Into<String>>(self, bearer_format: S) -> Self
Add or change informative bearer format for http security schema.
This is only applicable to HttpAuthScheme::Bearer
.
§Examples
Add JTW bearer format for security schema.
Http::new(HttpAuthScheme::Bearer).bearer_format("JWT");
Sourcepub fn description<S: Into<String>>(self, description: S) -> Self
pub fn description<S: Into<String>>(self, description: S) -> Self
Add or change optional description supporting markdown syntax.
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>,
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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
key
and return true
if they are equal.