Struct KrakenWSSClient

pub struct KrakenWSSClient { /* private fields */ }

A client for connecting to Kraken websockets via the V2 protocol.

Implementations

impl KrakenWSSClient

pub fn new() -> KrakenWSSClient

Create a client using the default Kraken URLs.

pub fn new_with_urls(base_url: String, auth_url: String) -> KrakenWSSClient

Create a client with custom URLs.

This is most useful for use with a proxy, or for testing.

pub fn new_with_tracing( base_url: &str, auth_url: &str, trace_inbound: bool, trace_outbound: bool, ) -> KrakenWSSClient

pub async fn connect<T>(&mut self) -> Result<KrakenMessageStream<T>, WSSError>

where T: for<'d> Deserialize<'d>,

Connect to the Kraken public websocket channel, returning a Result containing a KrakenMessageStream of [PublicMessage]s.

pub async fn connect_auth<T>( &mut self, ) -> Result<KrakenMessageStream<T>, WSSError>

where T: for<'d> Deserialize<'d>,

Connect to the Kraken private websocket channel, returning a Result containing a KrakenMessageStream of [PrivateMessage]s.

Trait Implementations

impl Clone for KrakenWSSClient

fn clone(&self) -> KrakenWSSClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KrakenWSSClient

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

Formats the value using the given formatter.

impl Default for KrakenWSSClient

fn default() -> Self

Returns the “default value” for a type.