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 validate(&self) -> Result<()>

Validates the configured instrument selections.

Errors

Returns an error if a selection lists no instruments, instrument IDs repeat, or an instrument does not map to the selected exchange.

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