Struct OAuthSession 

pub struct OAuthSession { /* private fields */ }

Manages the OAuth2 authorization process and token lifecycle for accessing the QCS API.

This struct encapsulates the necessary information to request an access token from an authorization server, including the OAuth2 grant type and any associated credentials or payload data.

Fields

• payload - The OAuth2 grant type and associated data that will be used to request an access token.
• access_token - The access token currently in use, if any. If no token has been provided or requested yet, this will be None.
• auth_server - The authorization server responsible for issuing tokens.

Implementations

impl OAuthSession

pub const fn new( payload: OAuthGrant, auth_server: AuthServer, access_token: Option<String>, ) -> Self

Initialize a new set of [Credentials] using a [GrantPayload].

Optionally include an access_token, if not included, then one can be requested with Self::request_access_token.

pub const fn from_externally_managed( tokens: ExternallyManaged, auth_server: AuthServer, access_token: Option<String>, ) -> Self

Initialize a new set of [Credentials] using an ExternallyManaged.

Optionally include an access_token, if not included, then one can be requested with Self::request_access_token.

pub const fn from_refresh_token( tokens: RefreshToken, auth_server: AuthServer, access_token: Option<String>, ) -> Self

Initialize a new set of [Credentials] using a RefreshToken.

Optionally include an access_token, if not included, then one can be requested with Self::request_access_token.

pub const fn from_client_credentials( tokens: ClientCredentials, auth_server: AuthServer, access_token: Option<String>, ) -> Self

Initialize a new set of [Credentials] using ClientCredentials.

Optionally include an access_token, if not included, then one can be requested with Self::request_access_token.

pub const fn from_pkce_flow( flow: PkceFlow, auth_server: AuthServer, access_token: Option<String>, ) -> Self

Initialize a new set of [Credentials] using PkceFlow.

Optionally include an access_token, if not included, then one can be requested with Self::request_access_token.

pub fn access_token(&self) -> Result<&str, TokenError>

Get the current access token.

This is an unvalidated copy of the access token. Meaning it can become stale, or may even be already be stale. See Self::validate and Self::request_access_token.

Errors

• TokenError::NoAccessToken if there is no access token

pub const fn payload(&self) -> &OAuthGrant

Get the payload used to request an access token.

pub async fn request_access_token(&mut self) -> Result<&str, TokenError>

Request and return an updated access token using these credentials.

Errors

See TokenError

pub const fn auth_server(&self) -> &AuthServer

The AuthServer that issues the tokens.

pub 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 an access token has not been requested.
• TokenError::InvalidAccessToken if the access token is invalid.

Trait Implementations

impl Clone for OAuthSession

fn clone(&self) -> OAuthSession

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthSession

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 OAuthSession

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

Performs the conversion.

impl PyClass for OAuthSession

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for OAuthSession

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

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForOAuthSession

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 PyClassNewTextSignature<OAuthSession> for PyClassImplCollector<OAuthSession>

fn new_text_signature(self) -> Option<&'static str>

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

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

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

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

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

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

impl PyTypeInfo for OAuthSession

const NAME: &'static str = "OAuthSession"

Class name.

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

Module name, if any.

type AsRefTarget = PyCell<OAuthSession>

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.