Struct BinanceSpotWsTradingClient 

pub struct BinanceSpotWsTradingClient { /* private fields */ }

Binance Spot WebSocket API client for SBE trading.

This client provides order management via WebSocket with SBE-encoded responses, complementing the HTTP client with lower-latency order submission.

Implementations

impl BinanceSpotWsTradingClient

pub fn new( url: Option<String>, api_key: String, api_secret: String, heartbeat: Option<u64>, transport_backend: TransportBackend, ) -> Self

Creates a new BinanceSpotWsTradingClient instance.

pub fn with_proxy(self, proxy_url: Option<String>) -> Self

Configures the proxy used by the WebSocket connection.

pub fn with_socket_control(self, control: SocketControl) -> Self

Configures socket state reporting and reconnect control.

pub const fn with_recv_window(self, recv_window_ms: Option<u64>) -> Self

Configures the receive window added to signed WebSocket API requests.

pub fn with_env( url: Option<String>, api_key: Option<String>, api_secret: Option<String>, heartbeat: Option<u64>, transport_backend: TransportBackend, ) -> Result<Self>

Creates a new client with credentials sourced from environment variables.

Falls back to env vars if api_key or api_secret are None:

• BINANCE_API_KEY for the API key
• BINANCE_API_SECRET for the API secret

Errors

Returns an error if credentials are missing from environment.

pub fn from_env(url: Option<String>, heartbeat: Option<u64>) -> Result<Self>

Creates a new client with credentials loaded entirely from environment variables.

Reads:

• BINANCE_API_KEY for the API key
• BINANCE_API_SECRET for the API secret

Errors

Returns an error if environment variables are missing.

pub fn is_active(&self) -> bool

Returns whether the client is actively connected.

pub fn is_user_data_active(&self) -> bool

Returns whether the private user data stream is active on the current connection.

pub fn mark_user_data_active(&self)

Marks the private user data stream active on the current connection.

pub fn mark_user_data_inactive(&self)

Marks the private user data stream inactive.

pub fn is_closed(&self) -> bool

Returns whether the client is closed.

pub fn next_request_id(&self) -> String

Generates the next request ID.

pub async fn connect(&mut self) -> BinanceWsApiResult<()>

Connects to the WebSocket API server.

Errors

Returns an error if connection fails.

pub async fn disconnect(&mut self) -> BinanceWsApiResult<()>

Disconnects from the WebSocket API server.

Errors

Returns an error if the handler task fails or does not stop after abort.

pub async fn place_order( &self, params: NewOrderParams, ) -> BinanceWsApiResult<String>

Places a new order via WebSocket API.

Errors

Returns an error if the handler is unavailable.

pub async fn place_order_with_id( &self, id: String, params: NewOrderParams, ) -> BinanceWsApiResult<()>

Places a new order via WebSocket API using a pre-generated request ID.

Errors

Returns an error if the handler is unavailable.

pub async fn cancel_order( &self, params: CancelOrderParams, ) -> BinanceWsApiResult<String>

Cancels an order via WebSocket API.

Errors

Returns an error if the handler is unavailable.

pub async fn cancel_order_with_id( &self, id: String, params: CancelOrderParams, ) -> BinanceWsApiResult<()>

Cancels an order via WebSocket API using a pre-generated request ID.

Errors

Returns an error if the handler is unavailable.

pub async fn cancel_replace_order( &self, params: CancelReplaceOrderParams, ) -> BinanceWsApiResult<String>

Cancels and replaces an order atomically via WebSocket API.

Errors

Returns an error if the handler is unavailable.

pub async fn cancel_replace_order_with_id( &self, id: String, params: CancelReplaceOrderParams, ) -> BinanceWsApiResult<()>

Cancels and replaces an order atomically via WebSocket API using a pre-generated request ID.

Errors

Returns an error if the handler is unavailable.

pub async fn cancel_all_orders( &self, symbol: impl Into<String>, ) -> BinanceWsApiResult<String>

Cancels all open orders for a symbol via WebSocket API.

Errors

Returns an error if the handler is unavailable.

pub async fn recv(&self) -> Option<BinanceSpotWsTradingMessage>

Receives the next message from the handler.

Returns None if the receiver is closed or not initialized.

pub async fn session_logon(&self) -> BinanceWsApiResult<()>

Authenticates the WebSocket session via session.logon.

Errors

Returns an error if the handler is unavailable.

pub async fn subscribe_user_data(&self) -> BinanceWsApiResult<()>

Subscribes to the user data stream via userDataStream.subscribe.

Errors

Returns an error if the handler is unavailable.

Trait Implementations

impl Clone for BinanceSpotWsTradingClient

fn clone(&self) -> BinanceSpotWsTradingClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinanceSpotWsTradingClient

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

Formats the value using the given formatter.