Struct BinanceSpotWebSocketClient 

pub struct BinanceSpotWebSocketClient { /* private fields */ }

Binance Spot WebSocket client for SBE market data streams.

Implementations

impl BinanceSpotWebSocketClient

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

Creates a new BinanceSpotWebSocketClient instance.

Errors

Returns an error if credential creation fails.

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 fn subscription_count(&self) -> usize

Returns the number of confirmed subscriptions.

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

Connects to the WebSocket server.

Errors

Returns an error if connection fails.

Panics

Panics if the internal output receiver mutex is poisoned.

pub async fn close(&mut self) -> BinanceWsResult<()>

Closes the WebSocket connection.

Errors

Returns an error if disconnect fails.

Panics

Panics if the internal output receiver mutex is poisoned.

pub async fn subscribe(&self, streams: Vec<String>) -> BinanceWsResult<()>

Subscribes to the specified streams.

Errors

Returns an error if subscription fails or would exceed stream limit.

pub async fn unsubscribe(&self, streams: Vec<String>) -> BinanceWsResult<()>

Unsubscribes from the specified streams.

Errors

Returns an error if unsubscription fails.

pub fn stream(&self) -> impl Stream<Item = NautilusWsMessage> + 'static

Returns a stream of messages from the WebSocket.

This method can only be called once per connection. Subsequent calls will return an empty stream. If you need to consume messages from multiple tasks, clone the client before connecting.

Panics

Panics if the internal output receiver mutex is poisoned.

pub fn cache_instruments(&self, instruments: Vec<InstrumentAny>)

Bulk initialize the instrument cache.

pub fn cache_instrument(&self, instrument: InstrumentAny)

Update a single instrument in the cache.

pub fn get_instrument(&self, symbol: &str) -> Option<InstrumentAny>

Get an instrument from the cache.

Trait Implementations

impl Clone for BinanceSpotWebSocketClient

fn clone(&self) -> BinanceSpotWebSocketClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinanceSpotWebSocketClient

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

Formats the value using the given formatter.

impl Default for BinanceSpotWebSocketClient

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for BinanceSpotWebSocketClient

type Target = BinanceSpotWebSocketClient

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BinanceSpotWebSocketClient

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 client for SBE market data streams.

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

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 PyClassNewTextSignature for BinanceSpotWebSocketClient

const TEXT_SIGNATURE: &'static str = "(url=None, api_key=None, api_secret=None, heartbeat=None)"

impl PyMethods<BinanceSpotWebSocketClient> for PyClassImplCollector<BinanceSpotWebSocketClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for BinanceSpotWebSocketClient

const NAME: &'static str = "BinanceSpotWebSocketClient"

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 BinanceSpotWebSocketClient

impl ExtractPyClassWithClone for BinanceSpotWebSocketClient