Skip to main content

BinanceKlineStream

Struct BinanceKlineStream 

Source
pub struct BinanceKlineStream { /* private fields */ }
Available on crate feature live-binance only.
Expand description

A live Binance kline stream.

Implementations§

Source§

impl BinanceKlineStream

Source

pub async fn connect(symbols: &[String], interval: Interval) -> Result<Self>

Connect to Binance’s combined-stream endpoint for one or more symbols.

Symbols may be passed in either case; they are lowercased to match Binance’s stream-name conventions. A dropped or stalled connection is re-established transparently by next_event.

Source

pub async fn connect_with_config( symbols: &[String], interval: Interval, config: BinanceConfig, ) -> Result<Self>

Connect with a custom BinanceConfig. Useful for Binance Testnet ("wss://testnet.binance.vision") or for shrinking the reconnect timing in integration tests.

Source

pub fn is_closed(&self) -> bool

Whether the caller has closed the stream. Once closed, every further next_event call yields Ok(None) immediately.

Source

pub async fn next_event(&mut self) -> Result<Option<KlineEvent>>

Receive the next kline event. A dropped, errored or stalled connection is re-established transparently (exponential backoff, up to BinanceConfig::max_reconnect_attempts); an exhausted reconnect surfaces as Err. Ok(None) is returned only after the caller has closed the stream.

Source

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

Close the underlying socket cleanly and mark the stream closed. After this, next_event yields Ok(None) and never reconnects.

Trait Implementations§

Source§

impl Debug for BinanceKlineStream

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V