Module qcs_api_client_common::configuration

This module is used for loading configuration that will be used to connect either to real QPUs (and supporting services) or the QVM.

By default, all settings are loaded from files located under your home directory in a .qcs folder. settings.toml will be used to load general settings (e.g. which URLs to connect to) and secrets.toml will be used to load tokens for authentication. Both “settings” and “secrets” files should contain profiles. The default_profile_name in settings sets the profile to be used when there is no override. You can set the PROFILE_NAME_VAR to select a different profile. You can also use SECRETS_PATH_VAR and SETTINGS_PATH_VAR to change which files are loaded.

Structs

• AuthServer
  Okta authorization server.
• ClientConfiguration
  All the config data that’s parsed from config sources
• ClientConfigurationBuilder
  Builder for ClientConfiguration to set/override items.
• Tokens
  A single type containing an access token and an associated refresh token.

Enums

• BuildError
  Errors that may occur when building a ClientConfiguration.
• LoadError
  Errors that may occur while loading a Configuration.
• RefreshError
  Errors that may occur while refreshing the access token.

Constants

• DEFAULT_API_URL
  Default URL to access the QCS API.
• DEFAULT_AUTH_SERVER_NAME
  Default auth server name
• DEFAULT_GRPC_API_URL
  Default URL to access the gRPC API.
• DEFAULT_QUILC_URL
  Default URL to access quilc.
• DEFAULT_QVM_URL
  Default URL to access QVM.
• GRPC_API_URL_VAR
  Setting this environment variable will override the URL used to connect to the GRPC server.
• PROFILE_NAME_VAR
  Setting this environment variable will change which profile is used from the loaded config files
• QUILC_URL_VAR
  Setting this environment variable will override the URL used to access quilc.
• QVM_URL_VAR
  Setting this environment variable will override the URL used to access the QVM.
• SECRETS_PATH_VAR
  Setting the QCS_SECRETS_FILE_PATH environment variable will change which file is used for loading secrets
• SETTINGS_PATH_VAR
  Setting the QCS_SETTINGS_FILE_PATH environment variable will change which file is used for loading settings

Traits

• TokenRefresher
  Get and refresh access tokens