Struct utoipa::openapi::security::Scopes

source ·
pub struct Scopes { /* private fields */ }
Expand description

OAuth2 flow scopes object defines required permissions for oauth flow.

Scopes must be given to oauth2 flow but depending on need one of few initialization methods could be used.

Examples

Create empty map of scopes.

let scopes = Scopes::new();

Create Scopes holding one scope.

let scopes = Scopes::one("edit:item", "edit pets");

Create map of scopes from iterator.

let scopes = Scopes::from_iter([
    ("edit:items", "edit my items"),
    ("read:items", "read my items")
]);

Implementations§

source§

impl Scopes

source

pub fn new() -> Self

Construct new Scopes with empty map of scopes. This is useful if oauth flow does not need any permission scopes.

Examples

Create empty map of scopes.

let scopes = Scopes::new();
source

pub fn one<S: Into<String>>(scope: S, description: S) -> Self

Construct new Scopes with holding one scope.

  • scope Is be the permission required.
  • description Short description about the permission.
Examples

Create map of scopes with one scope item.

let scopes = Scopes::one("edit:item", "edit items");

Trait Implementations§

source§

impl Clone for Scopes

source§

fn clone(&self) -> Scopes

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 Default for Scopes

source§

fn default() -> Scopes

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for Scopes

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<I> FromIterator<(I, I)> for Scopeswhere I: Into<String>,

source§

fn from_iter<T: IntoIterator<Item = (I, I)>>(iter: T) -> Self

Creates a value from an iterator. Read more
source§

impl PartialEq<Scopes> for Scopes

source§

fn eq(&self, other: &Scopes) -> 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 Scopes

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 Scopes

source§

impl StructuralEq for Scopes

source§

impl StructuralPartialEq for Scopes

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>,