Struct OAuthRequirements 

#[non_exhaustive]
pub struct OAuthRequirements {
    pub canonical_scopes: String,
    /* private fields */
}

OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for “Read-only access to Google Calendar” and “Access to Cloud Platform”. Users can consent to a scope for an application, giving it permission to access that data on their behalf.

OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means.

In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs.

When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice.

Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions.

Fields (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.

canonical_scopes: String

The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted.

Example:

 canonical_scopes: https://www.googleapis.com/auth/calendar,
                   https://www.googleapis.com/auth/calendar.read

Implementations

impl OAuthRequirements

pub fn new() -> Self

pub fn set_canonical_scopes<T: Into<String>>(self, v: T) -> Self

Sets the value of canonical_scopes.

Trait Implementations

impl Clone for OAuthRequirements

fn clone(&self) -> OAuthRequirements

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthRequirements

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OAuthRequirements

fn default() -> OAuthRequirements

Returns the “default value” for a type.

impl Message for OAuthRequirements

fn typename() -> &'static str

The typename of this message.

impl PartialEq for OAuthRequirements

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OAuthRequirements