Struct ClientConfigurationBuilder 

pub struct ClientConfigurationBuilder { /* private fields */ }

Builder for ClientConfiguration.

Implementations

impl ClientConfigurationBuilder

pub fn api_url(&mut self, value: String) -> &mut Self

The URL for the QCS REST API.

pub fn grpc_api_url(&mut self, value: String) -> &mut Self

The URL for the QCS gRPC API.

pub fn quilc_url(&mut self, value: String) -> &mut Self

The URL of the quilc server.

pub fn qvm_url(&mut self, value: String) -> &mut Self

The URL of the QVM server.

pub fn build( &self, ) -> Result<ClientConfiguration, ClientConfigurationBuilderError>

Builds a new ClientConfiguration.

Errors

If a required field has not been initialized.

impl ClientConfigurationBuilder

pub fn oauth_session( &mut self, oauth_session: Option<OAuthSession>, ) -> &mut Self

The OAuthSession to use to authenticate with the QCS API.

When set to None, the configuration will not manage an OAuth Session, and access to the QCS API will be limited to unauthenticated routes.

Trait Implementations

impl Clone for ClientConfigurationBuilder

fn clone(&self) -> ClientConfigurationBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ClientConfigurationBuilder

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for ClientConfigurationBuilder

type Target = ClientConfigurationBuilder

The Python output type

type Output = Bound<'py, <ClientConfigurationBuilder as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for ClientConfigurationBuilder

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for ClientConfigurationBuilder

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)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"Builder for [`ClientConfiguration`](struct.ClientConfiguration.html).\n\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<ClientConfigurationBuilder>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForClientConfigurationBuilder

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for ClientConfigurationBuilder

const TEXT_SIGNATURE: &'static str = "()"

impl PyTypeInfo for ClientConfigurationBuilder

const NAME: &'static str = "ClientConfigurationBuilder"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for ClientConfigurationBuilder

impl ExtractPyClassWithClone for ClientConfigurationBuilder