Struct ConnectionConfig 

pub struct ConnectionConfig {
    pub url: String,
    pub auth: AuthRequest,
    pub connect_timeout: Duration,
    pub read_timeout: Duration,
    pub tls: TlsConfig,
    pub message_buffer: usize,
    pub event_buffer: usize,
    pub client_id: Option<String>,
}

Configuration for WebSocket connection.

Debug is implemented manually so embedded credentials cannot leak. The auth field is rendered as <redacted> and any query-string parameter on url whose name case-insensitively matches a known secret key (token, key, apikey, api_key, secret, password) has its value replaced with ***.

Fields

url: String

WebSocket endpoint URL

auth: AuthRequest

Authentication credentials

connect_timeout: Duration

Connection timeout (default: 30 seconds)

read_timeout: Duration

Read timeout for messages (default: 30 seconds)

tls: TlsConfig

Optional TLS customization (custom CA / accept invalid certs). Default means “use the OS trust store” — identical to pre-3.0.1 behaviour.

message_buffer: usize

Capacity of the inbound message channel that backs messages() and message_stream(). Defaults to DEFAULT_MESSAGE_BUFFER. Use ConnectionConfigBuilder::message_buffer to override.

event_buffer: usize

Capacity of the lifecycle event channel that backs events() and state_events(). Defaults to DEFAULT_EVENT_BUFFER. Use ConnectionConfigBuilder::event_buffer to override.

client_id: Option<String>

Optional caller-supplied identifier used as a metric label on the metrics feature. Defaults to None. Low-cardinality only — suitable for deployment / instance / service identifiers, never for per-request UUIDs (Prometheus storage explodes on high-cardinality labels). Values longer than CLIENT_ID_MAX_LEN are truncated by the builder.

Implementations

impl ConnectionConfig

pub fn new(url: impl Into<String>, auth: AuthRequest) -> ConnectionConfig

Create a new connection configuration

pub fn builder( url: impl Into<String>, auth: AuthRequest, ) -> ConnectionConfigBuilder

Create a builder for fluent configuration

pub fn client_id(&self) -> Option<&str>

Caller-supplied identifier used as a metric label, or None if unset. See ConnectionConfigBuilder::client_id.

pub fn fugle_stock(auth: AuthRequest) -> ConnectionConfig

Create configuration for Fugle stock WebSocket endpoint

Example

use marketdata_core::websocket::ConnectionConfig;
use marketdata_core::AuthRequest;

let config = ConnectionConfig::fugle_stock(
    AuthRequest::with_api_key("my-api-key")
);
assert_eq!(config.url, "wss://api.fugle.tw/marketdata/v1.0/stock/streaming");

pub fn fugle_futopt(auth: AuthRequest) -> ConnectionConfig

Create configuration for Fugle futures/options WebSocket endpoint

Example

use marketdata_core::websocket::ConnectionConfig;
use marketdata_core::AuthRequest;

let config = ConnectionConfig::fugle_futopt(
    AuthRequest::with_api_key("my-api-key")
);
assert_eq!(config.url, "wss://api.fugle.tw/marketdata/v1.0/futopt/streaming");

Trait Implementations

impl Clone for ConnectionConfig

fn clone(&self) -> ConnectionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionConfig

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

Formats the value using the given formatter.