Struct qcs_api_client_common :: configuration :: ClientConfiguration Copy item path

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

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for ClientConfiguration

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

Formats the value using the given formatter. Read more

impl Default for ClientConfiguration

fn default() -> Self

Returns the “default value” for a type. Read more

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

Auto Trait Implementations§

impl !UnwindSafe for ClientConfiguration

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more