Struct ClientConfiguration 

pub struct ClientConfiguration { /* private fields */ }

A configuration suitable for use as a QCS API Client.

This configuration can be constructed in a few ways.

The most common way is to use ClientConfiguration::load_default. This will load the configuration associated with your default QCS profile.

When loading your config, any values set by environment variables will override the values in your configuration files.

You can also build a configuration from scratch using ClientConfigurationBuilder. Using a builder bypasses configuration files and environment overrides.

Implementations

impl ClientConfiguration

pub fn get_oauth_session(&self, py: Python<'_>) -> PyResult<OAuthSession>

Get the configured tokens.

Errors

• Raises a TokenError if there is a problem fetching the tokens

impl ClientConfiguration

pub fn load_default() -> Result<Self, LoadError>

Attempts to load config files

Errors

See LoadError

pub fn load_profile(profile_name: String) -> Result<Self, LoadError>

Attempts to load a QCS configuration and creates a ClientConfiguration using the specified profile.

Errors

See LoadError

pub async fn load_with_login( cancel_token: CancellationToken, profile_name: Option<String>, ) -> Result<Self, LoadError>

Attempts to load a QCS configuration and creates a ClientConfiguration using the specified profile. If no profile_name is provided, then a default configuration is loaded. When stored OAuth credentials are unavailable, this method falls back to an interactive PKCE login flow.

Errors

See LoadError

pub fn builder() -> ClientConfigurationBuilder

Get a ClientConfigurationBuilder

pub fn profile(&self) -> &str

Get the name of the profile that was loaded, if any.

pub fn api_url(&self) -> &str

Get the URL of the QCS REST API.

pub fn grpc_api_url(&self) -> &str

Get the URL of the QCS gRPC API.

pub fn quilc_url(&self) -> &str

Get the URL of the quilc server.

pub fn qvm_url(&self) -> &str

Get the URL of the QVM server.

pub const fn source(&self) -> &ConfigSource

Get the source of the configuration.

pub async fn oauth_session(&self) -> Result<OAuthSession, TokenError>

Get a copy of the current OAuthSession.

Note: This is a copy, the contained tokens will become stale once they expire.

Errors

See TokenError

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

Gets the Bearer access token, refreshing it if it is expired.

Errors

See TokenError.

pub async fn refresh(&self) -> Result<OAuthSession, TokenError>

Refreshes the [Tokens] in use and returns the new bearer access token.

Errors

See TokenError

Trait Implementations

impl Clone for ClientConfiguration

fn clone(&self) -> ClientConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfiguration

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

Formats the value using the given formatter.

impl IntoPy<Py<PyAny>> for ClientConfiguration

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

Performs the conversion.

impl PyClass for ClientConfiguration

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for ClientConfiguration

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

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForClientConfiguration

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 ClientConfiguration

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

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

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

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

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

impl PyTypeInfo for ClientConfiguration

const NAME: &'static str = "ClientConfiguration"

Class name.

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

Module name, if any.

type AsRefTarget = PyCell<ClientConfiguration>

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.

impl TokenRefresher for ClientConfiguration

type Error = TokenError

The type to be returned in the event of a error during getting or refreshing an access token

fn validated_access_token<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get and validate the current access token, refreshing it if it doesn’t exist or is invalid.

fn refresh_access_token<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a fresh access token

fn get_access_token<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the current access token, if any

fn base_url(&self) -> &str

Get the base URL for requests

fn should_trace(&self, url: &UrlPatternMatchInput) -> bool

Returns whether the given URL should be traced. Following [TracingConfiguration::is_enabled], this defaults to true.