Struct RefreshTokenRef

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

A Refresh Token

Implementations

impl RefreshTokenRef

pub const fn from_str(raw: &str) -> &Self

Transparently reinterprets the string slice as a strongly-typed RefreshTokenRef

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

Transparently reinterprets the static string slice as a strongly-typed RefreshTokenRef

pub fn into_owned(self: Box<RefreshTokenRef>) -> RefreshToken

Converts a Box<RefreshTokenRef> into a RefreshToken without copying or allocating

pub const fn as_str(&self) -> &str

Provides access to the underlying value as a string slice.

impl RefreshTokenRef

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.

impl RefreshTokenRef

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 RefreshTokenRef

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 RefreshTokenRef

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Debug for RefreshTokenRef

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for &'a RefreshTokenRef

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

Deserialize this value from the given Serde deserializer.

impl<'de> Deserialize<'de> for Box<RefreshTokenRef>

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

Deserialize this value from the given Serde deserializer.

impl Display for RefreshTokenRef

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

Formats the value using the given formatter.

impl<'a, 'b: 'a> From<&'a Cow<'b, RefreshTokenRef>> for &'a RefreshTokenRef

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

Converts to this type from the input type.

impl From<&RefreshTokenRef> for Arc<RefreshTokenRef>

fn from(r: &RefreshTokenRef) -> Self

Converts to this type from the input type.

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

fn from(r: &'a RefreshTokenRef) -> Self

Converts to this type from the input type.

impl From<&RefreshTokenRef> for Rc<RefreshTokenRef>

fn from(r: &RefreshTokenRef) -> Self

Converts to this type from the input type.

impl From<&RefreshTokenRef> for RefreshToken

fn from(s: &RefreshTokenRef) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for &'a RefreshTokenRef

fn from(s: &'a str) -> &'a RefreshTokenRef

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 Hash for RefreshTokenRef

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

Feeds this value into the given Hasher.

impl Ord for RefreshTokenRef

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

This method returns an Ordering between self and other.

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 RefreshTokenRef

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 PartialOrd for RefreshTokenRef

fn partial_cmp(&self, other: &RefreshTokenRef) -> 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 RefreshTokenRef

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

Serialize this value into the given Serde serializer.

impl ToOwned for RefreshTokenRef

type Owned = RefreshToken

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for RefreshTokenRef

impl StructuralPartialEq for RefreshTokenRef