Struct CoinbaseWebSocketClient 

pub struct CoinbaseWebSocketClient { /* private fields */ }

WebSocket client for Coinbase Advanced Trade market data and user streams.

Manages connection lifecycle, subscription state, and JWT authentication. Spawns a FeedHandler task that parses raw messages into Nautilus types.

Implementations

impl CoinbaseWebSocketClient

pub fn new( url: &str, transport_backend: TransportBackend, proxy_url: Option<String>, ) -> Self

Creates a new CoinbaseWebSocketClient for public market data.

pub fn with_credential( url: &str, credential: CoinbaseCredential, transport_backend: TransportBackend, proxy_url: Option<String>, ) -> Self

Creates a new CoinbaseWebSocketClient with credentials for authenticated channels.

pub async fn set_account_id(&mut self, account_id: AccountId)

Sets the account ID used when emitting user-channel execution reports.

Propagates to the feed handler when the connection is active so that subsequent user events carry the correct account identifier.

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

Bulk-populates the instrument cache.

Safe to call before or after Self::connect. When called before connect, instruments are picked up by the initial InitializeInstruments command the client sends to the handler; when called after, a fresh InitializeInstruments command is sent to refresh the handler’s cache.

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

Establishes the WebSocket connection and spawns the feed handler.

pub async fn subscribe( &self, channel: CoinbaseWsChannel, product_ids: &[Ustr], ) -> Result<()>

Subscribes to a channel for the given product IDs.

pub async fn unsubscribe( &self, channel: CoinbaseWsChannel, product_ids: &[Ustr], ) -> Result<()>

Unsubscribes from a channel for the given product IDs.

pub async fn next_message(&mut self) -> Option<NautilusWsMessage>

Returns the next parsed message from the feed handler.

pub async fn disconnect(&mut self)

Disconnects the WebSocket and stops the feed handler.

pub fn is_active(&self) -> bool

Returns true if the WebSocket connection is active.

pub fn is_reconnecting(&self) -> bool

Returns true if the WebSocket is reconnecting after a transport drop.

pub fn instruments(&self) -> &Arc<AtomicMap<InstrumentId, InstrumentAny>>

Returns a reference to the instrument cache.

pub fn subscription_aliases(&self) -> &Arc<AtomicMap<Ustr, Ustr>>

Returns a reference to the canonical-to-subscribed alias map.

pub fn register_subscription_alias(&self, canonical: Ustr, subscribed: Ustr)

Records that inbound messages carrying canonical should be re-keyed to subscribed. Caller is the data/exec client at subscribe or submit time when the local product id differs from Coinbase’s canonical alias.

pub fn unregister_subscription_alias(&self, canonical: &Ustr)

Removes an alias registration. Safe to call if no entry exists.

pub fn subscriptions(&self) -> &SubscriptionState

Returns the subscription state.

pub async fn update_instrument(&self, instrument: InstrumentAny)

Updates an instrument in the cache and notifies the handler.

pub fn take_out_rx(&mut self) -> Option<UnboundedReceiver<NautilusWsMessage>>

Takes the output message receiver, leaving None in its place.

Used by the data client to move the receiver into a background consumption task.

pub fn register_bar_type(&mut self, key: String, bar_type: BarType)

Registers a bar type locally without notifying the handler.

Used by the data client to persist registrations on the original client before cloning for async command dispatch.

pub async fn add_bar_type(&mut self, key: String, bar_type: BarType)

Registers a bar type for candle parsing.

Trait Implementations

impl Clone for CoinbaseWebSocketClient

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoinbaseWebSocketClient

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

Formats the value using the given formatter.

impl<'a, 'py> FromPyObject<'a, 'py> for CoinbaseWebSocketClient

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for CoinbaseWebSocketClient

type Target = CoinbaseWebSocketClient

The Python output type

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

const NAME: &str = "CoinbaseWebSocketClient"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for CoinbaseWebSocketClient

const MODULE: Option<&str>

Module which the class will be associated with.

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 = /// WebSocket client for Coinbase Advanced Trade market data and user streams. /// /// Manages connection lifecycle, subscription state, and JWT authentication. /// Spawns a [`FeedHandler`] task that parses raw messages into Nautilus types.

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 Layout = <<CoinbaseWebSocketClient as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<CoinbaseWebSocketClient>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForCoinbaseWebSocketClient

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

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyStubType for CoinbaseWebSocketClient

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for CoinbaseWebSocketClient

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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 CoinbaseWebSocketClient