Struct tokio_binance::WebSocketStream

pub struct WebSocketStream { /* fields omitted */ }

Websocket stream for the various binance channels aka streams.

Implementations

impl WebSocketStream

pub async fn connect<U: Into<String>>(
    channel: Channel<'_>,
    url: U
) -> Result<Self>

Start websocket stream by connecting to a channel.

Example

use tokio_binance::{WebSocketStream, BINANCE_US_WSS_URL, Channel};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let channel = Channel::Ticker("BNBUSDT");
    let mut stream = WebSocketStream::connect(channel, BINANCE_US_WSS_URL).await?;
    Ok(())
}

pub async fn text(&mut self) -> Result<Option<String>>

Helper method for getting messages as text.

Example

while let Some(text) = stream.text().await? {
    println!("{}", text);
}

pub async fn json<J: DeserializeOwned>(&mut self) -> Result<Option<J>>

Helper method for getting messages as a serde deserializable.

Example

use serde_json::Value;

while let Some(value) = stream.json::<Value>().await? {
    // filter the messages before accessing a field.
    if channel == value["stream"] {
        println!("{}", serde_json::to_string_pretty(&value)?);
    }
}

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

Subscribe to one or more channels aka streams.

Example

use tokio_binance::{Channel, Interval};

stream.subscribe(&[
    Channel::AggTrade("BNBUSDT"),
    Channel::Ticker("BTCUSDT"),
    Channel::Kline("BNBUSDT", Interval::OneMinute)
    // and so on
]).await?;

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

Unsubscribe from one or more channels aka streams.

Example

use tokio_binance::{Channel, Interval};

stream.unsubscribe(&[
    Channel::AggTrade("BNBUSDT"),
    Channel::Kline("BNBUSDT", Interval::OneMinute)
    // and so on
]).await?;

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

Returns a shared reference to the inner stream.

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

Returns a mutable reference to the inner stream.

pub async fn close(&mut self, msg: Option<CloseFrame<'_>>) -> Result<()>

Close the underlying web socket

Trait Implementations

impl Sink<Message> for WebSocketStream

type Error = Error

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

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

Attempts to prepare the Sink to receive a value.

fn start_send(
    mut 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(
    mut self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

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

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

impl Stream for WebSocketStream

type Item = Result<Message>

Values yielded by the stream.

fn poll_next(
    mut 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.

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

Returns the bounds on the remaining length of the stream.