Struct ClientConfig 

pub struct ClientConfig {
    pub api_key: Option<String>,
    pub environment: Environment,
    pub region: ApiRegion,
    pub base_url: Option<String>,
    pub recv_window: u32,
    pub debug: bool,
    pub timeout_ms: u64,
    pub referer: Option<String>,
    /* private fields */
}

Client configuration.

Fields

api_key: Option<String>

API key (required for private endpoints).

environment: Environment

Environment (production, testnet, demo).

region: ApiRegion

API region for production.

base_url: Option<String>

Custom base URL (overrides environment/region).

recv_window: u32

Request validity window in milliseconds.

debug: bool

Enable request/response logging.

timeout_ms: u64

Request timeout in milliseconds.

referer: Option<String>

Referer header value.

Implementations

impl ClientConfig

pub fn new(api_key: impl Into<String>, api_secret: impl Into<String>) -> Self

Create a new configuration with API credentials.

pub fn public_only() -> Self

Create a configuration for public endpoints only (no authentication).

pub fn environment(self, env: Environment) -> Self

Set the environment.

pub fn testnet(self) -> Self

Use testnet environment.

pub fn demo(self) -> Self

Use demo trading environment.

pub fn region(self, region: ApiRegion) -> Self

Set the API region (for production only).

pub fn base_url(self, url: impl Into<String>) -> Self

Set a custom base URL.

pub fn recv_window(self, ms: u32) -> Self

Set the recv_window value.

pub fn debug(self, enabled: bool) -> Self

Enable debug mode.

pub fn timeout_ms(self, ms: u64) -> Self

Set request timeout.

pub fn referer(self, referer: impl Into<String>) -> Self

Set referer header.

pub fn get_rest_url(&self) -> &str

Get the effective REST API base URL.

pub fn get_ws_public_url(&self, category: Category) -> String

Get the WebSocket URL for public streams.

pub fn get_ws_private_url(&self) -> &'static str

Get the WebSocket URL for private streams.

pub fn get_ws_trade_url(&self) -> &'static str

Get the WebSocket URL for trade API.

pub fn has_credentials(&self) -> bool

Check if authentication is configured.

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.