Struct SupervisedSpotWs 

pub struct SupervisedSpotWs { /* private fields */ }

A supervised connection: a Stream of Events that survives drops, stalls and Binance’s 24-hour cutoff.

Every Event::Disconnected is followed by an Event::Reconnected for the same path while the client runs. A connection that closes because its last stream left, while it is up, yields neither.

A fatal error, such as the server refusing a replay after a reconnect, is yielded as Err and then the stream ends. An Err(SpotWsError::Frame { .. }), a frame that did not decode, does not end it.

use futures_util::StreamExt;
use polyoxide_binance::spot::{types::Symbol, ws::{Event, SpotWsBuilder, SpotWsError, StreamName}};

let btc = Symbol::new("BTCUSDT")?;
let mut feed = SpotWsBuilder::new()
    .streams([StreamName::MiniTicker(btc.clone()), StreamName::BookTicker(btc)])
    .connect()
    .await?;
let membership = feed.membership();
while let Some(event) = feed.next().await {
    let event = match event {
        Ok(event) => event,
        // A frame that did not decode is skipped; anything else ends the stream.
        Err(SpotWsError::Frame { .. }) => continue,
        Err(err) => return Err(err.into()),
    };
    match event {
        Event::Update(update) => println!("{}", serde_json::to_string(&update)?),
        Event::Disconnected { path, reason } => eprintln!("{path} down: {reason}"),
        Event::Reconnected { path } => eprintln!("{path} back"),
        _ => {}
    }
}

Implementations

impl SupervisedSpotWs

pub fn membership(&self) -> MembershipHandle

A handle for changing streams while the stream runs.

pub async fn close(self) -> Result<(), SpotWsError>

Close the connection and stop. Every MembershipHandle answers SpotWsError::Stopped afterwards.

Fails with SpotWsError::Stopped if the client had stopped on an error, which the stream yielded: its cause is that error, as Classify read it, and so is the cause every later membership call carries. That holds once the router has the stop: a close() made right after the stream yielded the stopping error can return Ok or Stopped { cause: None }. Read the stream to its end first to be sure of the cause.

Trait Implementations

impl Debug for SupervisedSpotWs

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

Formats the value using the given formatter.

impl Stream for SupervisedSpotWs

type Item = Result<Event, SpotWsError>

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.