Struct CoinApiDataClientConfig 

pub struct CoinApiDataClientConfig {

    pub api_key: Option<SecretString>,
    pub base_url_http: Option<String>,
    pub base_url_ws: Option<String>,
    pub proxy_url: Option<SecretString>,
    pub instruments: Vec<CoinApiInstrumentSelection>,
    pub credit_budget: u64,
    pub max_retries: u32,
    pub http_timeout_secs: u64,
    pub max_concurrent_requests: usize,
    pub retry_delay_initial_ms: u64,
    pub retry_delay_max_ms: u64,
    pub retry_max_elapsed_ms: u64,
    pub transport_backend: TransportBackend,
    pub book_snapshot_timeout_secs: u64,
    pub price_precisions: HashMap<InstrumentId, u8>,
}

Configuration for CoinApiDataClient.

Fields

api_key: Option<SecretString>

API key; None falls back to the COINAPI_API_KEY environment variable.

base_url_http: Option<String>

Optional override for the REST base URL, including its version prefix.

base_url_ws: Option<String>

Optional override for the WebSocket URL.

proxy_url: Option<SecretString>

Optional explicit proxy URL for HTTP and WebSocket transports.

instruments: Vec<CoinApiInstrumentSelection>

Instruments loaded on connect and served by instrument requests.

credit_budget: u64

Conservative lifetime REST credit allowance for this client; see CoinApiHttpConfig.

max_retries: u32

Maximum retries for a failed REST request.

http_timeout_secs: u64

Positive per-attempt REST timeout in seconds, including concurrency admission.

max_concurrent_requests: usize

Maximum simultaneous REST requests for this client instance.

retry_delay_initial_ms: u64

Initial REST retry delay in milliseconds.

retry_delay_max_ms: u64

Maximum REST retry backoff in milliseconds; provider retry delays can exceed it.

retry_max_elapsed_ms: u64

Positive total REST elapsed budget in milliseconds, including admission and retries.

transport_backend: TransportBackend

WebSocket transport backend.

book_snapshot_timeout_secs: u64

Seconds to wait for an order book snapshot after a subscription, reconnect, or recovery request; zero disables the deadline.

price_precisions: HashMap<InstrumentId, u8>

Price precision by selected instrument, replacing the CoinAPI price resolution when it is coarser than the prices the venue quotes.

Implementations

impl CoinApiDataClientConfig

pub fn builder() -> CoinApiDataClientConfigBuilder

Create an instance of CoinApiDataClientConfig using the builder syntax

impl CoinApiDataClientConfig

pub fn http_config(&self) -> CoinApiHttpConfig

Returns the REST transport configuration, applying overrides to the defaults.

pub fn websocket_config(&self) -> CoinApiWebSocketConfig

Returns the WebSocket transport configuration, applying overrides to the defaults.

Trait Implementations

impl ClientConfig for CoinApiDataClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for CoinApiDataClientConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoinApiDataClientConfig

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

Formats the value using the given formatter.

impl Default for CoinApiDataClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for CoinApiDataClientConfig

impl<'de> Deserialize<'de> for CoinApiDataClientConfig

where CoinApiDataClientConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'py> FromPyObject<'a, 'py> for CoinApiDataClientConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for CoinApiDataClientConfig

type Target = CoinApiDataClientConfig

The Python output type

type Output = Bound<'py, <CoinApiDataClientConfig 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 CoinApiDataClientConfig

const NAME: &str = "CoinApiDataClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for CoinApiDataClientConfig

const MODULE: Option<&str>

Module which the class will be associated with.

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 = /// Configuration for [`CoinApiDataClient`](crate::data::CoinApiDataClient).

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 Layout = <<CoinApiDataClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<CoinApiDataClientConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForCoinApiDataClientConfig

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

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for CoinApiDataClientConfig

const TEXT_SIGNATURE: &'static str = "(api_key=None, base_url_http=None, base_url_ws=None, instruments=None, credit_budget=None, max_retries=None, transport_backend=None, book_snapshot_timeout_secs=None, price_precisions=None, proxy_url=None, http_timeout_secs=None, max_concurrent_requests=None, retry_delay_initial_ms=None, retry_delay_max_ms=None, retry_max_elapsed_ms=None)"

impl PyStubType for CoinApiDataClientConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for CoinApiDataClientConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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 Serialize for CoinApiDataClientConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.