Enum Kind 

pub enum Kind {
    Trade,
    AggTrade,
    Kline(KlineInterval),
    Ticker,
    Orderbook,
    OrderbookDelta,
    MarkPrice,
    FundingRate,
    OpenInterest,
    Liquidation,
    BlockTrade,
    IndexPrice,
    CompositeIndex,
    OptionGreeks,
    VolatilityIndex,
    HistoricalVolatility,
    LongShortRatio,
    Basis,
    InsuranceFund,
    OrderbookL3,
    SettlementEvent,
    MarketWarning,
    RiskLimit,
    PredictedFunding,
    FundingSettlement,
    MarkPriceKline(KlineInterval),
    IndexPriceKline(KlineInterval),
    PremiumIndexKline(KlineInterval),
    RangeBar(u64),
    TickBar(u32),
    VolumeBar(u64),
    Footprint(KlineInterval),
    OrderUpdate,
    BalanceUpdate,
    PositionUpdate,
}

What kind of stream this series carries.

Kline carries a typed KlineInterval so different timeframes of the same symbol get their own series. All other kinds have no extra parameter.

Variants

Trade

AggTrade

Kline(KlineInterval)

Ticker

Orderbook

OrderbookDelta

MarkPrice

FundingRate

OpenInterest

Liquidation

BlockTrade

IndexPrice

CompositeIndex

OptionGreeks

VolatilityIndex

HistoricalVolatility

LongShortRatio

Basis

InsuranceFund

OrderbookL3

SettlementEvent

MarketWarning

RiskLimit

PredictedFunding

FundingSettlement

MarkPriceKline(KlineInterval)

IndexPriceKline(KlineInterval)

PremiumIndexKline(KlineInterval)

RangeBar(u64)

Range bar: a new bar opens when |trade.price − bar_open| ≥ range.

range is expressed as a fixed-point integer: price × 1e8. Example: a $1.00 range on a dollar-denominated pair = 100_000_000u64. This avoids carrying floats in Hash/Eq while keeping the unit explicit and independent of the minimum exchange tick.

TickBar(u32)

Tick bar: a new bar closes every n trades.

VolumeBar(u64)

Volume bar: a new bar closes when cumulative volume ≥ threshold.

threshold is expressed as a fixed-point integer: volume × 1e8. Example: 0.5 BTC threshold = 50_000_000u64.

Footprint(KlineInterval)

Footprint bar: time-bucketed OHLCV with per-price buy/sell breakdown.

Reuses KlineInterval for the time bucket (e.g. "1m", "5m").

OrderUpdate

Order lifecycle events (create/fill/cancel/expire). Auth-required.

BalanceUpdate

Account balance changes. Auth-required.

PositionUpdate

Futures position changes. Auth-required.

Implementations

impl Kind

pub fn fill_policy(&self) -> FillPolicy

Fill policy for collapsing this stream’s observations onto a bar. State streams carry forward; flow streams bucket-sum with zero gaps.

impl Kind

pub fn is_poll_only(&self) -> Option<PollSpec>

If this kind has no WS feed and must be driven by REST polling, returns the default cadence + jitter spec.

Poll-only kinds bypass ws.subscribe entirely in acquire_or_spawn and instead use the spawn_poller actor path.

pub fn slug(&self) -> String

Short kebab-case label for filesystem paths.

Trait Implementations

impl Clone for Kind

fn clone(&self) -> Kind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Kind

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

Formats the value using the given formatter.

impl Eq for Kind

impl Hash for Kind

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 Kind

fn eq(&self, other: &Kind) -> 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 StructuralPartialEq for Kind