Struct TokenResponse 

pub struct TokenResponse {
    pub access_token: String,
    pub refresh_token: Option<String>,
    pub expires_in: Option<u64>,
    pub token_type: Option<String>,
}

Response from the OAuth token endpoint.

This is the standard OAuth 2.0 token response format. The expires_in field is seconds from now, which must be converted to an absolute expires_at timestamp for storage.

Fields

access_token: String

The access token issued by the authorization server.

refresh_token: Option<String>

The refresh token (may not always be present, but required for stoat).

expires_in: Option<u64>

The lifetime of the access token in seconds.

token_type: Option<String>

The token type (typically “Bearer”).

Implementations

impl TokenResponse

pub fn into_stored_token( self, now_unix: u64, ) -> Result<StoredToken, MissingRefreshToken>

Convert to a StoredToken using the given current time.

now_unix is the current Unix timestamp in seconds. If expires_in is not present, the token is assumed to expire in 3600 seconds (1 hour).

Errors

Returns an error if refresh_token is None, since stoat requires a refresh token for automatic token renewal.

pub fn into_refreshed_token( self, fallback_refresh_token: &str, now_unix: u64, ) -> StoredToken

Convert a refresh response to a StoredToken, using the existing refresh token as a fallback.

During a token refresh, the authorization server may or may not issue a new refresh token. If the response does not include one, the existing fallback_refresh_token is preserved.

now_unix is the current Unix timestamp in seconds. If expires_in is not present, the token is assumed to expire in 3600 seconds (1 hour).

Trait Implementations

impl Clone for TokenResponse

fn clone(&self) -> TokenResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TokenResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.