Skip to main content

OKXWsMessage

Enum OKXWsMessage 

Source
pub enum OKXWsMessage {
Show 13 variants BookData { arg: OKXWebSocketArg, action: OKXBookAction, data: Vec<OKXBookMsg>, }, ChannelData { channel: OKXWsChannel, inst_id: Option<Ustr>, data: Value, }, OrderResponse { id: Option<String>, op: OKXWsOperation, code: String, msg: String, data: Vec<Value>, }, Orders(Vec<OKXOrderMsg>), SpreadOrders(Vec<OKXSpreadOrder>), AlgoOrders(Vec<OKXAlgoOrderMsg>), Account(Value), Positions(Value), Instruments(Vec<OKXInstrument>), SendFailed { request_id: String, client_order_id: Option<ClientOrderId>, op: Option<OKXWsOperation>, error: String, }, Error(OKXWebSocketError), Reconnected, Authenticated,
}
Expand description

Output from the OKX WebSocket handler.

Contains venue-specific types only. Data parsing occurs in PyOKXWebSocketClient (using an instruments cache), and execution parsing occurs in execution.rs (using the system Cache for order lookups).

Variants§

§

BookData

Order book snapshot or update.

§

ChannelData

Data from a non-book channel (trades, tickers, mark price, funding, candles, etc.).

Fields

§inst_id: Option<Ustr>
§data: Value
§

OrderResponse

Response to a WebSocket order command (place, cancel, amend, mass-cancel).

§

Orders(Vec<OKXOrderMsg>)

Order push channel updates.

§

SpreadOrders(Vec<OKXSpreadOrder>)

Nitro spread order push channel updates.

§

AlgoOrders(Vec<OKXAlgoOrderMsg>)

Algo order push channel updates.

§

Account(Value)

Account channel update (raw JSON).

§

Positions(Value)

Positions channel update (raw JSON).

§

Instruments(Vec<OKXInstrument>)

Instrument definition updates.

§

SendFailed

A WebSocket send failed without a structured venue response.

Fields

§request_id: String
§client_order_id: Option<ClientOrderId>
§error: String
§

Error(OKXWebSocketError)

Error received from OKX.

§

Reconnected

WebSocket reconnected.

§

Authenticated

WebSocket authenticated.

Trait Implementations§

Source§

impl Debug for OKXWsMessage

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more