Struct AccessToken

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

An Access Token

Implementations

impl AccessToken

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

Constructs a new AccessToken

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

Constructs a new AccessToken from a static reference

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

Converts this AccessToken into a Box<AccessTokenRef>

This will drop any excess capacity.

pub fn take(self) -> String

Unwraps the underlying String value

Methods from Deref<Target = AccessTokenRef>

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 AccessToken::as_str, but has another name for searchability, prefer to use this function.

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 AccessToken

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 AccessToken

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for AccessToken

fn clone(&self) -> AccessToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccessToken

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

Formats the value using the given formatter.

impl Deref for AccessToken

type Target = AccessTokenRef

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for AccessToken

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

Deserialize this value from the given Serde deserializer.

impl Display for AccessToken

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<&str> for AccessToken

fn from(s: &str) -> Self

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<'a> From<AccessToken> for Cow<'a, AccessTokenRef>

fn from(owned: AccessToken) -> Self

Converts to this type from the input type.

impl From<AccessToken> for String

fn from(s: AccessToken) -> Self

Converts to this type from the input type.

impl From<Box<AccessTokenRef>> for AccessToken

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

Converts to this type from the input type.

impl From<Box<str>> for AccessToken

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<String> for AccessToken

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromStr for AccessToken

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 AccessToken

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 AccessToken

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<&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 AccessToken

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

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 AccessToken

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

Serialize this value into the given Serde serializer.

impl Eq for AccessToken

impl StructuralPartialEq for AccessToken