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>, ) -> Self

Creates a new BinanceSpotWsTradingClient instance.

pub fn with_env( url: Option<String>, api_key: Option<String>, api_secret: Option<String>, heartbeat: Option<u64>, ) -> 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_closed(&self) -> bool

Returns whether the client is closed.

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

Connects to the WebSocket API server.

Errors

Returns an error if connection fails.

Panics

Panics if the internal output receiver mutex is poisoned.

pub async fn disconnect(&mut self)

Disconnects from the WebSocket API server.

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 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_replace_order( &self, params: CancelReplaceOrderParams, ) -> BinanceWsApiResult<String>

Cancel and replace an order atomically via WebSocket API.

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

Receives the next message from the handler.

Returns None if the receiver is closed or not initialized.

Panics

Panics if the internal output receiver mutex is poisoned.

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.

impl<'py> IntoPyObject<'py> for BinanceSpotWsTradingClient

type Target = BinanceSpotWsTradingClient

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BinanceSpotWsTradingClient

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 = /// 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.

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 BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<BinanceSpotWsTradingClient>

This handles following two situations:

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

fn weaklist_offset() -> Option<isize>

impl PyTypeInfo for BinanceSpotWsTradingClient

const NAME: &'static str = "BinanceSpotWsTradingClient"

Class name.

const MODULE: Option<&'static str>

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 DerefToPyAny for BinanceSpotWsTradingClient

impl ExtractPyClassWithClone for BinanceSpotWsTradingClient