Struct utoipa::openapi::security::OpenIdConnect
source · #[non_exhaustive]pub struct OpenIdConnect {
pub open_id_connect_url: String,
pub description: Option<String>,
}
Expand description
Open id connect SecurityScheme
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.open_id_connect_url: String
Url of the OpenIdConnect
to discover OAuth2 connect values.
description: Option<String>
Description of OpenIdConnect
SecurityScheme
supporting markdown syntax.
Implementations§
source§impl OpenIdConnect
impl OpenIdConnect
sourcepub fn new<S: Into<String>>(open_id_connect_url: S) -> Self
pub fn new<S: Into<String>>(open_id_connect_url: S) -> Self
Construct a new open id connect security schema.
§Examples
OpenIdConnect::new("https://localhost/openid");
sourcepub fn with_description<S: Into<String>>(
open_id_connect_url: S,
description: S,
) -> Self
pub fn with_description<S: Into<String>>( open_id_connect_url: S, description: S, ) -> Self
Construct a new OpenIdConnect
SecurityScheme
with optional description
supporting markdown syntax.
§Examples
OpenIdConnect::with_description("https://localhost/openid", "my pet api open id connect");
Trait Implementations§
source§impl Clone for OpenIdConnect
impl Clone for OpenIdConnect
source§fn clone(&self) -> OpenIdConnect
fn clone(&self) -> OpenIdConnect
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 OpenIdConnect
impl<'de> Deserialize<'de> for OpenIdConnect
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 OpenIdConnect
impl PartialEq for OpenIdConnect
source§fn eq(&self, other: &OpenIdConnect) -> bool
fn eq(&self, other: &OpenIdConnect) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl Serialize for OpenIdConnect
impl Serialize for OpenIdConnect
impl Eq for OpenIdConnect
impl StructuralPartialEq for OpenIdConnect
Auto Trait Implementations§
impl Freeze for OpenIdConnect
impl RefUnwindSafe for OpenIdConnect
impl Send for OpenIdConnect
impl Sync for OpenIdConnect
impl Unpin for OpenIdConnect
impl UnwindSafe for OpenIdConnect
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.