Struct rocket_oauth2::TokenResponse

pub struct TokenResponse { /* fields omitted */ }

The server's response to a successful token exchange, defined in in RFC 6749 §5.1.

Methods

impl TokenResponse

pub fn as_value(&self) -> &Value

Get the TokenResponse data as a raw JSON Value. It is guaranteed to be of type Object.

pub fn access_token(&self) -> &str

Get the access token issued by the authorization server.

pub fn token_type(&self) -> &str

Get the type of token, described in RFC 6749 §7.1.

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

Get the lifetime in seconds of the access token, if the authorization server provided one.

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

Get the refresh token, if the server provided one.

pub fn scope(&self) -> Option<&str>

Get the (space-separated) list of scopes associated with the access token. The authorization server is required to provide this if it differs from the requested set of scopes.

If scope was not provided by the server as a string, this method will return None. For those providers, use `.as_value().get("scope") instead.

Trait Implementations

impl Clone for TokenResponse

fn clone(&self) -> TokenResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<TokenResponse> for TokenResponse

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

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

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

This method tests for !=.

impl Debug for TokenResponse

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

Formats the value using the given formatter.

impl TryFrom<Value> for TokenResponse

type Error = Error

The type returned in the event of a conversion error.

fn try_from(data: Value) -> Result<Self, Error>

Construct a TokenResponse from a Value.

Returns an Error if data is not a JSON Object, or the access_token or token_type is missing or not a string.