Struct RefreshToken

pub struct RefreshToken(/* private fields */);

A Refresh Token

Implementations

impl RefreshToken

pub const fn new(raw: String) -> Self

Constructs a new RefreshToken

pub fn from_static(raw: &'static str) -> Self

Constructs a new RefreshToken from a static reference

pub fn into_boxed_ref(self) -> Box<RefreshTokenRef>

Converts this RefreshToken into a Box<RefreshTokenRef>

This will drop any excess capacity.

pub fn take(self) -> String

Unwraps the underlying String value

Methods from Deref<Target = RefreshTokenRef>

pub fn as_str(&self) -> &str

Provides access to the underlying value as a string slice.

pub fn secret(&self) -> &str

Get the secret from this string.

This function is the same as RefreshToken::as_str, but has another name for searchability, prefer to use this function.

pub fn refresh_token_request( &self, client_id: &ClientId, client_secret: &ClientSecret, ) -> Request<Vec<u8>>

Get the request needed to refresh this token.

Parse the response from this endpoint with TwitchTokenResponse::from_response

pub async fn refresh_token<'a, C>( &self, http_client: &'a C, client_id: &ClientId, client_secret: &ClientSecret, ) -> Result<(AccessToken, Duration, Option<RefreshToken>), RefreshTokenError<<C as Client>::Error>>

where C: Client,

Available on crate feature client only.

Refresh the token, call if it has expired.

See https://dev.twitch.tv/docs/authentication/refresh-tokens

Trait Implementations

impl AsRef<RefreshTokenRef> for RefreshToken

fn as_ref(&self) -> &RefreshTokenRef

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for RefreshToken

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<RefreshTokenRef> for RefreshToken

fn borrow(&self) -> &RefreshTokenRef

Immutably borrows from an owned value.

impl Borrow<str> for RefreshToken

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for RefreshToken

fn clone(&self) -> RefreshToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RefreshToken

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

Formats the value using the given formatter.

impl Deref for RefreshToken

type Target = RefreshTokenRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for RefreshToken

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for RefreshToken

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

Formats the value using the given formatter.

impl From<&RefreshTokenRef> for RefreshToken

fn from(s: &RefreshTokenRef) -> Self

Converts to this type from the input type.

impl From<&str> for RefreshToken

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Box<RefreshTokenRef>> for RefreshToken

fn from(r: Box<RefreshTokenRef>) -> Self

Converts to this type from the input type.

impl From<Box<str>> for RefreshToken

fn from(s: Box<str>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, RefreshTokenRef>> for RefreshToken

fn from(r: Cow<'a, RefreshTokenRef>) -> Self

Converts to this type from the input type.

impl From<RefreshToken> for Box<RefreshTokenRef>

fn from(r: RefreshToken) -> Self

Converts to this type from the input type.

impl<'a> From<RefreshToken> for Cow<'a, RefreshTokenRef>

fn from(owned: RefreshToken) -> Self

Converts to this type from the input type.

impl From<RefreshToken> for String

fn from(s: RefreshToken) -> Self

Converts to this type from the input type.

impl From<String> for RefreshToken

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromStr for RefreshToken

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for RefreshToken

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RefreshToken

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<&RefreshTokenRef> for RefreshToken

fn eq(&self, other: &&RefreshTokenRef) -> 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 PartialEq<RefreshToken> for &RefreshTokenRef

fn eq(&self, other: &RefreshToken) -> 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 PartialEq<RefreshToken> for RefreshTokenRef

fn eq(&self, other: &RefreshToken) -> 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 PartialEq<RefreshTokenRef> for RefreshToken

fn eq(&self, other: &RefreshTokenRef) -> 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 PartialEq for RefreshToken

fn eq(&self, other: &RefreshToken) -> 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 PartialOrd for RefreshToken

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RefreshToken

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for RefreshToken

impl StructuralPartialEq for RefreshToken