Struct utoipa::openapi::security::OAuth2

source ·
#[non_exhaustive]
pub struct OAuth2 { pub flows: BTreeMap<String, Flow>, pub description: Option<String>, }
Expand description

OAuth2 Flow configuration for 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.
§flows: BTreeMap<String, Flow>

Map of supported OAuth2 flows.

§description: Option<String>

Optional description for the OAuth2 Flow SecurityScheme.

Implementations§

source§

impl OAuth2

source

pub fn new<I: IntoIterator<Item = Flow>>(flows: I) -> Self

Construct a new OAuth2 security schema configuration object.

Oauth flow accepts slice of Flow configuration objects and can be optionally provided with description.

Examples

Create new OAuth2 flow with multiple authentication flows.

OAuth2::new([Flow::Password(
    Password::with_refresh_url(
        "https://localhost/oauth/token",
        Scopes::from_iter([
            ("edit:items", "edit my items"),
            ("read:items", "read my items")
        ]),
        "https://localhost/refresh/token"
    )),
    Flow::AuthorizationCode(
        AuthorizationCode::new(
        "https://localhost/authorization/token",
        "https://localhost/token/url",
        Scopes::from_iter([
            ("edit:items", "edit my items"),
            ("read:items", "read my items")
        ])),
   ),
]);
source

pub fn with_description<I: IntoIterator<Item = Flow>, S: Into<String>>( flows: I, description: S ) -> Self

Construct a new OAuth2 flow with optional description supporting markdown syntax.

Examples

Create new OAuth2 flow with multiple authentication flows with description.

OAuth2::with_description([Flow::Password(
    Password::with_refresh_url(
        "https://localhost/oauth/token",
        Scopes::from_iter([
            ("edit:items", "edit my items"),
            ("read:items", "read my items")
        ]),
        "https://localhost/refresh/token"
    )),
    Flow::AuthorizationCode(
        AuthorizationCode::new(
        "https://localhost/authorization/token",
        "https://localhost/token/url",
        Scopes::from_iter([
            ("edit:items", "edit my items"),
            ("read:items", "read my items")
        ])
     ),
   ),
], "my oauth2 flow");

Trait Implementations§

source§

impl Clone for OAuth2

source§

fn clone(&self) -> OAuth2

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<'de> Deserialize<'de> for OAuth2

source§

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<OAuth2> for OAuth2

source§

fn eq(&self, other: &OAuth2) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for OAuth2

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for OAuth2

source§

impl StructuralEq for OAuth2

source§

impl StructuralPartialEq for OAuth2

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,