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

pub fn quilc_url(&self) -> &str

URL to access quilc over TCP. Defaults to DEFAULT_QUILC_URL.

pub fn qvm_url(&self) -> &str

URL to access QVM over HTTP. Defaults to DEFAULT_QVM_URL.

impl ClientConfiguration

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

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

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

Errors

See LoadError.

pub async fn set_tokens(&mut self, tokens: Tokens)

Manually set access and refresh tokens

Most users do not want to use this. Instead, use ClientConfiguration::load(), which uses your QCS configuration.

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.