Struct OAuth2Properties

pub struct OAuth2Properties<C: Client> {
    pub config: C::Configuration,
    pub scopes: Vec<String>,
    pub grace_period: Duration,
    pub max_expiration: Option<Duration>,
    pub audience: Option<String>,
    pub children: Children,
    pub login_options: Option<LoginOptions>,
    pub logout_options: Option<LogoutOptions>,
}

Properties for the context component.

Fields

config: C::Configuration

The client configuration

scopes: Vec<String>

Scopes to request for the session

grace_period: Duration

The grace period for the session timeout

The amount of time before the token expiration when the agent will refresh it.

max_expiration: Option<Duration>

A maximum expiration time.

This can be used to limit the token timeout. If present, the token will be considered expired at the provided expiration or the configured maximum expiration, whatever is first.

audience: Option<String>

children: Children

Children which will have access to the OAuth2Context.

login_options: Option<LoginOptions>

Default LoginOptions that will be used unless more specific options have been requested.

logout_options: Option<LogoutOptions>

Default LogoutOptions that will be used unless more specific options have been requested.

Trait Implementations

impl<C: Clone + Client> Clone for OAuth2Properties<C>

where C::Configuration: Clone,

fn clone(&self) -> OAuth2Properties<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug + Client> Debug for OAuth2Properties<C>

where C::Configuration: Debug,

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

Formats the value using the given formatter.

impl<C: Client> PartialEq for OAuth2Properties<C>

fn eq(&self, other: &Self) -> 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<C: Client> Properties for OAuth2Properties<C>

type Builder = OAuth2PropertiesBuilder<C>

Builder that will be used to construct properties

fn builder() -> Self::Builder

Entrypoint for building properties