Struct oauth2::TokenResponse

pub struct TokenResponse<EF: ExtraTokenFields, TT: TokenType> { /* private fields */ }

Common methods shared by all OAuth2 token implementations.

The methods in this struct are defined in Section 5.1 of RFC 6749.

Implementations

impl<EF: ExtraTokenFields, TT: TokenType> TokenResponse<EF, TT>

pub fn access_token(&self) -> &AccessToken

REQUIRED. The access token issued by the authorization server.

pub fn token_type(&self) -> &TT

REQUIRED. The type of the token issued as described in Section 7.1. Value is case insensitive and deserialized to the generic TokenType parameter.

pub fn expires_in(&self) -> Option<Duration>

RECOMMENDED. The lifetime in seconds of the access token. For example, the value 3600 denotes that the access token will expire in one hour from the time the response was generated. If omitted, the authorization server SHOULD provide the expiration time via other means or document the default value.

pub fn refresh_token(&self) -> Option<&RefreshToken>

OPTIONAL. The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in Section 6.

pub fn scopes(&self) -> Option<&Vec<Scope>>

OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. The scipe of the access token as described by Section 3.3. If included in the response, this space-delimited field is parsed into a Vec of individual scopes. If omitted from the response, this field is None.

pub fn extra_fields(&self) -> &EF

Extra fields defined by client application.

pub fn from_json(data: &str) -> Result<Self, Error>

Factory method to deserialize a Token from a JSON response.

Failures

If parsing fails, returns a serde_json::error::Error describing the parse error.

Trait Implementations

impl<EF: Debug + ExtraTokenFields, TT: Debug + TokenType> Debug for TokenResponse<EF, TT>

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

Formats the value using the given formatter.

impl<'de, EF, TT> Deserialize<'de> for TokenResponse<EF, TT>where
    TT: TokenType,
    EF: ExtraTokenFields,

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

Deserialize this value from the given Serde deserializer.

impl<EF: PartialEq + ExtraTokenFields, TT: PartialEq + TokenType> PartialEq<TokenResponse<EF, TT>> for TokenResponse<EF, TT>

fn eq(&self, other: &TokenResponse<EF, TT>) -> bool

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

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.

impl<EF, TT> Serialize for TokenResponse<EF, TT>where
    TT: TokenType,
    EF: ExtraTokenFields,

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

Serialize this value into the given Serde serializer.

impl<EF: ExtraTokenFields, TT: TokenType> StructuralPartialEq for TokenResponse<EF, TT>