Struct Arg 

#[non_exhaustive]
pub struct Arg {
    pub channel: String,
    pub inst_id: Option<String>,
    pub inst_type: Option<String>,
    pub inst_family: Option<String>,
    pub extra: BTreeMap<String, String>,
}

A WebSocket channel argument used in subscribe/unsubscribe requests and returned in channel acknowledgements/data pushes.

Use Arg::new for a channel-only subscription, then add standard instrument filters or custom channel parameters with consuming setters.

OKX docs: https://www.okx.com/docs-v5/en/#overview-websocket-subscribe

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

channel: String

OKX channel name, e.g. tickers, books5, account, or orders.

inst_id: Option<String>

Instrument ID, e.g. BTC-USDT.

inst_type: Option<String>

Instrument type, e.g. SPOT or SWAP.

inst_family: Option<String>

Instrument family, e.g. BTC-USD.

extra: BTreeMap<String, String>

Additional channel parameters not modeled as first-class fields.

Implementations

impl Arg

pub fn new(channel: impl Into<String>) -> Self

Create a channel argument.

pub fn inst_id(self, inst_id: impl Into<String>) -> Self

Set the instrument ID.

pub fn inst_type(self, inst_type: impl Into<String>) -> Self

Set the instrument type.

pub fn inst_family(self, inst_family: impl Into<String>) -> Self

Set the instrument family.

pub fn param(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set an arbitrary channel parameter.

pub fn extra_param(self, update_interval: impl Into<String>) -> Self

Set the extraParams parameter.

pub fn ccy(self, ccy: impl Into<String>) -> Self

Set the currency parameter.

pub fn sprd_id(self, sprd_id: impl Into<String>) -> Self

Set the spread ID parameter.

pub fn algo_id(self, algo_id: impl Into<String>) -> Self

Set the algo order ID parameter.

pub fn grid_type(self, grid_type: impl Into<String>) -> Self

Set the grid type parameter.

Trait Implementations

impl Clone for Arg

fn clone(&self) -> Arg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Arg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Arg

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Arg

impl Hash for Arg

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 Arg

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Arg

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 Arg