Struct TokenDispatcher 

pub struct TokenDispatcher { /* private fields */ }

A wrapper for OAuthSession that provides thread-safe access to the inner tokens.

Implementations

impl TokenDispatcher

pub async fn use_tokens<F, O>(&self, f: F) -> O

where F: FnOnce(&OAuthSession) -> O + Send,

Executes a user-provided closure on a reference to the Tokens instance managed by the dispatcher.

This function locks the mutex, safely exposing the protected Tokens instance to the provided closure f. It is designed to allow safe and controlled access to the Tokens instance for reading its state.

Parameters

• f: A closure that takes a reference to Tokens and returns a value of type O. The closure is called with the Tokens instance as an argument once the mutex is successfully locked.

pub async fn tokens(&self) -> OAuthSession

Get a copy of the current access token.

pub async fn refresh( &self, source: &ConfigSource, profile: &str, ) -> Result<OAuthSession, TokenError>

Refreshes the tokens. Readers will be blocked until the refresh is complete.

Errors

See TokenError

pub async fn validate(&self) -> Result<String, TokenError>

Validate the access token, returning it if it is valid, or an error describing why it is invalid.

Errors

• TokenError::NoAccessToken if there is no access token
• TokenError::InvalidAccessToken if the access token is invalid

Trait Implementations

impl Clone for TokenDispatcher

fn clone(&self) -> TokenDispatcher

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenDispatcher

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

Formats the value using the given formatter.

impl From<OAuthSession> for TokenDispatcher

fn from(value: OAuthSession) -> Self

Converts to this type from the input type.

impl IntoPy<Py<PyAny>> for TokenDispatcher

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PyClass for TokenDispatcher

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for TokenDispatcher

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<TokenDispatcher>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForTokenDispatcher

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a TokenDispatcher

type Holder = Option<PyRef<'py, TokenDispatcher>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut TokenDispatcher

type Holder = Option<PyRefMut<'py, TokenDispatcher>>

fn extract(obj: &'py PyAny, holder: &'a mut Self::Holder) -> PyResult<Self>

impl PyTypeInfo for TokenDispatcher

const NAME: &'static str = "TokenDispatcher"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

type AsRefTarget = PyCell<TokenDispatcher>

Utility type to make Py::as_ref work.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.