Enum Topic 

pub enum Topic {
    AggTrade {
        symbol: String,
    },
    Depth {
        symbol: String,
        depth: OrderbookDepth,
    },
    BookTicker {
        symbol: String,
    },
    MarkPrice {
        symbol: String,
    },
    Kline {
        symbol: String,
        interval: KlineInterval,
    },
    ForceOrder {
        symbol: String,
    },
    AllTickers,
    AllMarkPrices,
    AllBookTickers,
    AllForceOrders,
}

A WebSocket subscription topic.

Topics are created using the static constructor methods and converted to the wire format automatically when passed to subscribe().

Available Topics

Topic	Description
Topic::agg_trade	Aggregated trade updates
Topic::depth	Order book depth snapshots
Topic::book_ticker	Best bid/ask prices
Topic::mark_price	Mark price updates
Topic::kline	Candlestick/kline data
Topic::force_order	Liquidation orders
Topic::all_tickers	All symbol mini tickers
Topic::all_mark_prices	All mark prices
Topic::all_book_tickers	All best bid/ask
Topic::all_force_orders	All liquidations

Variants

AggTrade

Aggregated trade stream for a symbol.

Fields

symbol: String

Depth

Order book depth stream with configurable levels.

Fields

symbol: String

depth: OrderbookDepth

BookTicker

Best bid/ask stream for a symbol.

Fields

symbol: String

MarkPrice

Mark price stream for a symbol.

Fields

symbol: String

Kline

Kline/candlestick stream for a symbol at an interval.

Fields

symbol: String

interval: KlineInterval

ForceOrder

Liquidation order stream for a symbol.

Fields

symbol: String

AllTickers

All symbols mini ticker stream.

AllMarkPrices

All symbols mark price stream.

AllBookTickers

All symbols book ticker stream.

AllForceOrders

All symbols liquidation stream.

Implementations

impl Topic

pub fn agg_trade(symbol: impl Into<String>) -> Self

Subscribe to aggregated trades for a symbol.

Example

use bullet_rust_sdk::ws::topics::Topic;

let topic = Topic::agg_trade("BTC-USD");
assert_eq!(topic.to_string(), "BTC-USD@aggTrade");

pub fn depth(symbol: impl Into<String>, depth: OrderbookDepth) -> Self

Subscribe to order book depth for a symbol.

Example

use bullet_rust_sdk::ws::topics::{OrderbookDepth, Topic};

let topic = Topic::depth("BTC-USD", OrderbookDepth::D10);
assert_eq!(topic.to_string(), "BTC-USD@depth10");

pub fn book_ticker(symbol: impl Into<String>) -> Self

Subscribe to best bid/ask for a symbol.

Example

use bullet_rust_sdk::ws::topics::Topic;

let topic = Topic::book_ticker("BTC-USD");
assert_eq!(topic.to_string(), "BTC-USD@bookTicker");

pub fn mark_price(symbol: impl Into<String>) -> Self

Subscribe to mark price updates for a symbol.

Example

use bullet_rust_sdk::ws::topics::Topic;

let topic = Topic::mark_price("BTC-USD");
assert_eq!(topic.to_string(), "BTC-USD@markPrice");

pub fn kline(symbol: impl Into<String>, interval: KlineInterval) -> Self

Subscribe to kline/candlestick data for a symbol.

Example

use bullet_rust_sdk::ws::topics::{KlineInterval, Topic};

let topic = Topic::kline("BTC-USD", KlineInterval::H1);
assert_eq!(topic.to_string(), "BTC-USD@kline_1h");

pub fn force_order(symbol: impl Into<String>) -> Self

Subscribe to liquidation orders for a symbol.

Example

use bullet_rust_sdk::ws::topics::Topic;

let topic = Topic::force_order("BTC-USD");
assert_eq!(topic.to_string(), "BTC-USD@forceOrder");

pub fn all_tickers() -> Self

Subscribe to mini ticker updates for all symbols.

Example

use bullet_rust_sdk::ws::topics::Topic;

let topic = Topic::all_tickers();
assert_eq!(topic.to_string(), "!ticker@arr");

pub fn all_mark_prices() -> Self

Subscribe to mark price updates for all symbols.

Example

use bullet_rust_sdk::ws::topics::Topic;

let topic = Topic::all_mark_prices();
assert_eq!(topic.to_string(), "!markPrice@arr");

pub fn all_book_tickers() -> Self

Subscribe to book ticker updates for all symbols.

Example

use bullet_rust_sdk::ws::topics::Topic;

let topic = Topic::all_book_tickers();
assert_eq!(topic.to_string(), "!bookTicker@arr");

pub fn all_force_orders() -> Self

Subscribe to liquidation orders for all symbols.

Example

use bullet_rust_sdk::ws::topics::Topic;

let topic = Topic::all_force_orders();
assert_eq!(topic.to_string(), "!forceOrder@arr");

Trait Implementations

impl Clone for Topic

fn clone(&self) -> Topic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Topic

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

Formats the value using the given formatter.

impl Display for Topic

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

Formats the value using the given formatter.

impl From<Topic> for String

fn from(topic: Topic) -> Self

Converts to this type from the input type.

impl Hash for Topic

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 Topic

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

impl StructuralPartialEq for Topic