Struct qcs_api_client_common::configuration::ClientConfiguration

pub struct ClientConfiguration { /* private fields */ }

All the config data that’s parsed from config sources

Implementations

impl ClientConfiguration

pub fn builder() -> ClientConfigurationBuilder

Create a new configuration builder with the given tokens.

pub fn api_url(&self) -> &str

URL to access the QCS API. Defaults to DEFAULT_API_URL.

pub fn grpc_api_url(&self) -> &str

URL to access the gRPC API. Defaults to the value of the QCS_SETTINGS_APPLICATIONS_GRPC_URL environment variable if set, DEFAULT_GRPC_API_URL otherwise.

pub fn quilc_url(&self) -> &str

URL to access quilc. Defaults to the value of the QCS_SETTINGS_APPLICATIONS_QUILC_URL environment variable if set, DEFAULT_QUILC_URL otherwise.

pub fn qvm_url(&self) -> &str

URL to access QVM. Defaults to the value of the QCS_SETTINGS_APPLICATIONS_QVM_URL environment variable if set, DEFAULT_QVM_URL otherwise.

impl ClientConfiguration

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

Attempt to load config files from ~/.qcs and create a Configuration object for use with the QCS API using the default profile.

See https://docs.rigetti.com/qcs/references/qcs-client-configuration for details.

Errors

See LoadError.

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

Attempt to load config files from ~/.qcs and create a Configuration object for use with the QCS API using the specified profile.

See https://docs.rigetti.com/qcs/references/qcs-client-configuration for details.

Errors

See LoadError.

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

Gets the Bearer access token, refreshing it if expired.

Errors

See RefreshError.

pub async fn refresh(&self) -> Result<String, RefreshError>

Refresh the authentication tokens and return the new access token if successful.

Errors

See RefreshError.

Trait Implementations

impl Clone for ClientConfiguration

fn clone(&self) -> ClientConfiguration

Returns a copy 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 Default for ClientConfiguration

fn default() -> Self

Returns the “default value” for a type.

impl From<ClientConfiguration> for ClientConfigurationBuilder

fn from(config: ClientConfiguration) -> Self

Converts to this type from the input type.

impl TokenRefresher for ClientConfiguration

type Error = RefreshError

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

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<String, Self::Error>> + Send + 'async_trait>>

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

Get the current access token