Struct ExternallyManaged 

pub struct ExternallyManaged { /* private fields */ }

A struct that manages access tokens by utilizing a user-provided refresh function.

The ExternallyManaged struct allows users to define custom logic for fetching or refreshing access tokens.

Implementations

impl ExternallyManaged

pub fn new( refresh_function: impl Fn(AuthServer) -> Pin<Box<dyn Future<Output = Result<String, Box<dyn Error + Send + Sync>>> + Send>> + Send + Sync + 'static, ) -> Self

Creates a new ExternallyManaged instance from a RefreshFunction.

Consider using ExternallyManaged::from_async, and ExternallyManaged::from_sync, if they better fit your use case.

Arguments

• refresh_function - A function or closure that asynchronously refreshes a token.

Example

use qcs_api_client_common::configuration::{settings::AuthServer, tokens::ExternallyManaged, TokenError};
use std::future::Future;
use std::pin::Pin;
use std::boxed::Box;
use std::error::Error;

async fn example_refresh_function(_auth_server: AuthServer) -> Result<String, Box<dyn Error
+ Send + Sync>> {
    Ok("new_token_value".to_string())
}
let token_manager = ExternallyManaged::new(|auth_server| Box::pin(example_refresh_function(auth_server)));

pub fn from_async<F, Fut>(refresh_function: F) -> Self

where F: Fn(AuthServer) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<String, Box<dyn Error + Send + Sync>>> + Send + 'static,

Constructs a new ExternallyManaged instance using an async function or closure.

This method simplifies the creation of the ExternallyManaged instance by handling the boxing and pinning of the future internally.

Arguments

• refresh_function - An async function or closure that returns a Future which, when awaited, produces a Result<String, TokenError>.

Example

use qcs_api_client_common::configuration::{settings::AuthServer, tokens::ExternallyManaged, TokenError};
use tokio::runtime::Runtime;
use std::error::Error;

async fn example_refresh_function(_auth_server: AuthServer) -> Result<String, Box<dyn Error
+ Send + Sync>> {
    Ok("new_token_value".to_string())
}

let token_manager = ExternallyManaged::from_async(example_refresh_function);

let rt = Runtime::new().unwrap();
rt.block_on(async {
    match token_manager.request_access_token(&AuthServer::default()).await {
        Ok(token) => println!("Token: {token:?}"),
        Err(e) => println!("Failed to refresh token: {:?}", e),
    }
});

pub fn from_sync( refresh_function: impl Fn(AuthServer) -> Result<String, Box<dyn Error + Send + Sync>> + Send + Sync + 'static, ) -> Self

Constructs a new ExternallyManaged instance using a synchronous function.

The synchronous function is wrapped in an async block to fit the expected signature.

Arguments

• refresh_function - A synchronous function that returns a Result<String, TokenError>.

Example

use qcs_api_client_common::configuration::{settings::AuthServer, tokens::ExternallyManaged, TokenError};
use tokio::runtime::Runtime;
use std::error::Error;

fn example_sync_refresh_function(_auth_server: AuthServer) -> Result<String, Box<dyn Error
+ Send + Sync>> {
    Ok("sync_token_value".to_string())
}

let token_manager = ExternallyManaged::from_sync(example_sync_refresh_function);

let rt = Runtime::new().unwrap();
rt.block_on(async {
    match token_manager.request_access_token(&AuthServer::default()).await {
        Ok(token) => println!("Token: {token:?}"),
        Err(e) => println!("Failed to refresh token: {:?}", e),
    }
});

pub async fn request_access_token( &self, auth_server: &AuthServer, ) -> Result<SecretAccessToken, Box<dyn Error + Send + Sync>>

Request an updated access token using the provided refresh function.

Errors

Errors are propagated from the refresh function.

impl ExternallyManaged

pub fn __repr__(&self) -> String

Implements __repr__ for Python in terms of the Rust Debug implementation.

Trait Implementations

impl Clone for ExternallyManaged

fn clone(&self) -> ExternallyManaged

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternallyManaged

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

Formats the value using the given formatter.

impl From<ExternallyManaged> for OAuthGrant

fn from(v: ExternallyManaged) -> Self

Converts to this type from the input type.

impl<'py> IntoPyObject<'py> for ExternallyManaged

type Target = ExternallyManaged

The Python output type

type Output = Bound<'py, <ExternallyManaged as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for ExternallyManaged

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for ExternallyManaged

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)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// A struct that manages access tokens by utilizing a user-provided refresh function. /// /// The [`ExternallyManaged`] struct allows users to define custom logic for /// fetching or refreshing access tokens.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<ExternallyManaged>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForExternallyManaged

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

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for ExternallyManaged

const TEXT_SIGNATURE: &'static str = "(refresh_function)"

impl PyTypeInfo for ExternallyManaged

const NAME: &'static str = "ExternallyManaged"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

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

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for ExternallyManaged

impl ExtractPyClassWithClone for ExternallyManaged