Struct WsRequest 

pub struct WsRequest {
    pub op: String,
    pub req_id: String,
    pub args: Vec<Value>,
}

A request to the stream.

Fields

op: String

subscribe, unsubscribe, auth or ping.

req_id: String

An id of ours, repeated in the answer. Empty when none.

args: Vec<Value>

The topics (or the login arguments).

Implementations

impl WsRequest

pub fn subscribe(req_id: &str, topic: &str) -> Self

Subscribes to one topic, for example orderbook.50.BTCUSDT.

Examples

use brokapi_bybit_protocol::ws::models::WsRequest;

let r = WsRequest::subscribe("7", "orderbook.1.BTCUSDT");
assert_eq!(r.to_json(), r#"{"op":"subscribe","req_id":"7","args":["orderbook.1.BTCUSDT"]}"#);

pub fn unsubscribe(req_id: &str, topic: &str) -> Self

Cancels the subscription to one topic.

pub fn ping() -> Self

The heartbeat the exchange asks for every 20 seconds.

pub fn auth(api_key: &str, api_secret: &str, expires_ms: i64) -> Self

The login of the private stream: the key, the expires time (milliseconds) and the signature.

pub fn to_json(&self) -> String

The text that goes on the wire.

Trait Implementations

impl Clone for WsRequest

fn clone(&self) -> WsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsRequest

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

Formats the value using the given formatter.

impl PartialEq for WsRequest

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

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 WsRequest