Struct cbpro::websocket::WebSocketFeed

pub struct WebSocketFeed { /* fields omitted */ }

Stream with private or public access to Coinbase's Websocket Feed

Methods

impl WebSocketFeed

pub async fn connect<'_>(url: &'_ str) -> Result<WebSocketFeed>

Example

use cbpro::websocket::{WebSocketFeed, SANDBOX_FEED_URL, Channels};
use futures::TryStreamExt;

let mut feed = WebSocketFeed::connect(SANDBOX_FEED_URL).await?;
feed.subscribe(&["BTC-USD"], &[Channels::LEVEL2]).await?;

while let Some(value) = feed.try_next().await? {
    println!("{}", serde_json::to_string_pretty(&value).unwrap());
}

pub async fn connect_auth<'_>(
    key: String,
    pass: String,
    secret: String,
    url: &'_ str
) -> Result<WebSocketFeed>

Example

use cbpro::websocket::{WebSocketFeed, SANDBOX_FEED_URL, Channels};
use futures::TryStreamExt;

let mut feed = WebSocketFeed::connect_auth(String::new(), String::new(), String::new(), SANDBOX_FEED_URL).await?;
feed.subscribe(&["BTC-USD"], &[Channels::LEVEL2]).await?;

while let Some(value) = feed.try_next().await? {
    println!("{}", serde_json::to_string_pretty(&value).unwrap());
}

pub async fn subscribe<'_, '_, '_, '_, '_>(
    &'_ mut self,
    product_ids: &'_ [&'_ str],
    channels: &'_ [&'_ str]
) -> Result<()>

Subscribe to a list of channels and products.

pub async fn unsubscribe<'_, '_, '_, '_, '_>(
    &'_ mut self,
    product_ids: &'_ [&'_ str],
    channels: &'_ [&'_ str]
) -> Result<()>

Unsubscribe to a list of channels and products.

pub fn get_ref(
    &self
) -> &WebSocketStream<StreamSwitcher<TokioAdapter<TcpStream>, TokioAdapter<TlsStream<TokioAdapter<TokioAdapter<TcpStream>>>>>>

Returns a shared reference to the inner stream.

pub fn get_mut(
    &mut self
) -> &mut WebSocketStream<StreamSwitcher<TokioAdapter<TcpStream>, TokioAdapter<TlsStream<TokioAdapter<TokioAdapter<TcpStream>>>>>>

Returns a mutable reference to the inner stream.

pub fn response(&self) -> &Response

Returns a shared reference to the feed response.

pub async fn close(__arg0: Self) -> Result<()>

Sends a close frame

Trait Implementations

impl Sink<Message> for WebSocketFeed

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Message) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl Stream for WebSocketFeed

type Item = Result<Value>

Values yielded by the stream.

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.