Enum StreamName 

#[non_exhaustive]
pub enum StreamName {
    AllTickers,
    AllMarkPrices,
    AggTrade(Symbol),
    Kline(Symbol, Interval),
    MarkPrice(Symbol),
    Ticker(Symbol),
    PartialDepth(Symbol, DepthLevels, DepthSpeed),
    BookTicker(Symbol),
}

A USDⓈ-M market stream.

Display renders the wire name, with the symbol’s ASCII letters lowercased (btcusdt@aggTrade, 币安人生usdt@markPrice@1s), and FromStr parses an echoed name back; Symbol::new uppercases ASCII, so the two round-trip.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AllTickers

!ticker@arr: 24-hour tickers of every symbol that changed.

AllMarkPrices

!markPrice@arr@1s: mark price and funding of every symbol, each second.

AggTrade(Symbol)

<s>@aggTrade.

Kline(Symbol, Interval)

<s>@kline_<interval>.

MarkPrice(Symbol)

<s>@markPrice@1s.

Ticker(Symbol)

<s>@ticker.

PartialDepth(Symbol, DepthLevels, DepthSpeed)

<s>@depth<levels>@<speed>, on the /public path.

BookTicker(Symbol)

<s>@bookTicker, on the /public path.

Implementations

impl StreamName

pub fn path(&self) -> StreamPath

The path whose connection carries this stream.

pub fn symbol(&self) -> Option<&Symbol>

The symbol, for a single-symbol stream.

Trait Implementations

impl Clone for StreamName

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamName

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

Formats the value using the given formatter.

impl Display for StreamName

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

Formats the value using the given formatter.

impl Eq for StreamName

impl FromStr for StreamName

type Err = InvalidStreamName

The associated error which can be returned from parsing.

fn from_str(name: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for StreamName

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StreamName

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StreamName