Enum StreamKind 

pub enum StreamKind {
    Ticker,
    IndexPrice,
    MarkPrice,
    CompositeIndex,
    Orderbook,
    OrderbookDelta,
    OrderbookL3,
    Trade,
    AggTrade,
    BlockTrade,
    Kline {
        interval: KlineInterval,
    },
    MarkPriceKline {
        interval: KlineInterval,
    },
    IndexPriceKline {
        interval: KlineInterval,
    },
    PremiumIndexKline {
        interval: KlineInterval,
    },
    FundingRate,
    PredictedFunding,
    FundingSettlement,
    OpenInterest,
    LongShortRatio,
    InsuranceFund,
    RiskLimit,
    Basis,
    Liquidation,
    OptionGreeks,
    VolatilityIndex,
    HistoricalVolatility,
    SettlementEvent,
    AuctionEvent,
    MarketWarning,
    OrderUpdate,
    BalanceUpdate,
    PositionUpdate,
}

Full enumeration of all known WebSocket stream kinds across all supported exchanges.

Variants with { interval: KlineInterval } carry a parameter. All other variants are unit variants (no parameters).

Partitioned into groups for documentation; the enum itself is flat.

Variants

Ticker

Full 24-h rolling ticker (OHLCV + last price + volume)

IndexPrice

Index price feed (spot → perpetual fair value)

MarkPrice

Mark price feed (settlement-reference price)

CompositeIndex

Composite index price (constructed from multiple underlying sources)

Orderbook

Level-2 full-depth snapshot

OrderbookDelta

Level-2 incremental delta stream

OrderbookL3

Level-3 per-order (L3) full orderbook

Trade

Individual public trades (time-and-sales)

AggTrade

Aggregated trades (multiple fills at same price collapsed)

BlockTrade

Block trade / RFQ event (large off-book transactions)

Kline

Standard OHLCV candlestick

Fields

interval: KlineInterval

MarkPriceKline

Mark-price candlestick (futures)

Fields

interval: KlineInterval

IndexPriceKline

Index-price candlestick (futures)

Fields

interval: KlineInterval

PremiumIndexKline

Premium-index candlestick (futures; basis ≈ mark−index)

Fields

interval: KlineInterval

FundingRate

Live funding rate (updates intraperiod)

PredictedFunding

Predicted funding rate before settlement window opens

FundingSettlement

Actual funding settlement event (rate + charged amount)

OpenInterest

Open interest snapshot / update

LongShortRatio

Long/short ratio (market sentiment)

InsuranceFund

Insurance fund balance update

RiskLimit

Risk limit tier update (margin tiers)

Basis

Basis stream (futures price − spot price)

Liquidation

Forced-liquidation event (public)

OptionGreeks

Option greeks: delta/gamma/vega/theta/rho + IV

VolatilityIndex

Volatility index (e.g. DVOL on Deribit)

HistoricalVolatility

Historical realized volatility feed

SettlementEvent

Settlement / expiry delivery event

AuctionEvent

Auction event (indicative price, crossing state)

MarketWarning

Market warning / trading halt notification

OrderUpdate

Order lifecycle events (create/fill/cancel/expire)

BalanceUpdate

Account balance changes

PositionUpdate

Futures position changes

Implementations

impl StreamKind

pub fn is_private(&self) -> bool

Returns true if this stream kind requires authentication.

pub fn is_kline(&self) -> bool

Returns true if this variant carries a kline interval parameter.

Trait Implementations

impl Clone for StreamKind

fn clone(&self) -> StreamKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StreamKind

impl From<StreamKind> for StreamType

fn from(kind: StreamKind) -> Self

Converts to this type from the input type.

impl Hash for StreamKind

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 StreamKind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StreamKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamKind

impl TryFrom<StreamType> for StreamKind

type Error = WebSocketError

The type returned in the event of a conversion error.

fn try_from(st: StreamType) -> WebSocketResult<Self>

Performs the conversion.