Struct utoipa::openapi::security::Scopes

pub struct Scopes { /* private fields */ }

OAuth2 flow scopes object defines required permissions for oauh flow.

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

• Create empty map of scopes you can use Scopes::new.
• Create map with only one scope you can use Scopes::one.
• Create mutliple scopes from iterator with Scopes::from_iter.

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

impl Scopes

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();

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

Construct new Scopes with hodling 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

impl Clone for Scopes

fn clone(&self) -> Scopes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Scopes

fn default() -> Scopes

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<I> FromIterator<(I, I)> for Scopes where
    I: Into<String>, 

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

Creates a value from an iterator.

impl Serialize for Scopes

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

Serialize this value into the given Serde serializer.