Struct AccessTokenRef

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

An Access Token

Implementations

impl AccessTokenRef

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

Transparently reinterprets the string slice as a strongly-typed AccessTokenRef

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

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

pub fn into_owned(self: Box<AccessTokenRef>) -> AccessToken

Converts a Box<AccessTokenRef> into a AccessToken without copying or allocating

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

Provides access to the underlying value as a string slice.

impl AccessTokenRef

pub fn secret(&self) -> &str

Get the secret from this string.

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

impl AccessTokenRef

pub fn validate_token_request(&self) -> Request<Vec<u8>>

Get the request needed to validate this token.

Parse the response from this endpoint with ValidatedToken::from_response

pub async fn validate_token<'a, C>( &self, client: &'a C, ) -> Result<ValidatedToken, ValidationError<<C as Client>::Error>>

where C: Client,

Available on crate feature client only.

Validate this token.

Should be checked on regularly, according to https://dev.twitch.tv/docs/authentication/validate-tokens/

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

Get the request needed to revoke this token.

pub async fn revoke_token<'a, C>( &self, http_client: &'a C, client_id: &ClientId, ) -> Result<(), RevokeTokenError<<C as Client>::Error>>

where C: Client,

Available on crate feature client only.

Revoke the token.

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

Trait Implementations

impl AsRef<AccessTokenRef> for AccessToken

fn as_ref(&self) -> &AccessTokenRef

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

impl AsRef<str> for AccessTokenRef

fn as_ref(&self) -> &str

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

impl Borrow<AccessTokenRef> for AccessToken

fn borrow(&self) -> &AccessTokenRef

Immutably borrows from an owned value.

impl Borrow<str> for AccessTokenRef

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Debug for AccessTokenRef

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

Formats the value using the given formatter.

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

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<AccessTokenRef>

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

Deserialize this value from the given Serde deserializer.

impl Display for AccessTokenRef

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

Formats the value using the given formatter.

impl From<&AccessTokenRef> for AccessToken

fn from(s: &AccessTokenRef) -> Self

Converts to this type from the input type.

impl From<&AccessTokenRef> for Arc<AccessTokenRef>

fn from(r: &AccessTokenRef) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<&AccessTokenRef> for Rc<AccessTokenRef>

fn from(r: &AccessTokenRef) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<AccessToken> for Box<AccessTokenRef>

fn from(r: AccessToken) -> Self

Converts to this type from the input type.

impl Hash for AccessTokenRef

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

Feeds this value into the given Hasher.

impl Ord for AccessTokenRef

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

This method returns an Ordering between self and other.

impl PartialEq<&AccessTokenRef> for AccessToken

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

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

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

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

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

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

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

Serialize this value into the given Serde serializer.

impl ToOwned for AccessTokenRef

type Owned = AccessToken

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 AccessTokenRef

impl StructuralPartialEq for AccessTokenRef