Skip to main content

Frame

df_hyperliquid_core::live::frame

Enum Frame

pub enum Frame {
Show 33 variants    Pong,
    Ack(Ack),
    Error(Refusal),
    Post(Reply),
    AllMids(Mids),
    Book(Book),
    Trades(Vec<Trade>),
    Bbo(Bbo),
    Candle(Candle),
    AssetCtx {
        coin: String,
        ctx: PerpCtx,
    },
    SpotAssetCtx {
        coin: String,
        ctx: SpotCtx,
    },
    AssetData(ActiveAssetData),
    UserFills(UserFills),
    OrderUpdates(Vec<OrderUpdate>),
    UserEvent(UserEvent),
    UserFundings(UserFundings),
    Ledger(Ledger),
    ClearinghouseState(DexState),
    AllDexsClearinghouseState(AllDexsState),
    OpenOrders(OpenOrders),
    SpotState(SpotState),
    TwapStates(TwapStates),
    TwapSliceFills(TwapSliceFills),
    TwapHistory(TwapHistory),
    Notification(String),
    WebData3(WebData3),
    AllDexsAssetCtxs(Vec<(String, Vec<PerpCtx>)>),
    AssetCtxs {
        dex: String,
        ctxs: Vec<PerpCtx>,
    },
    SpotAssetCtxs(Vec<SpotCtx>),
    OutcomeMetaUpdates(Json),
    FastAssetCtxs(String),
    HistoricalOrders(HistoricalOrders),
    Other {
        channel: String,
        data: String,
    },
}

Expand description

One frame, by channel.

Variants§

Pong

pong: the answer to a ping.

Ack(Ack)

subscriptionResponse: the venue took a subscribe or an unsubscribe.

Error(Refusal)

error: the venue refused something sent, in its own words.

Post(Reply)

post: the answer to a post, by its id.

AllMids(Mids)

Book(Book)

l2Book.

Trades(Vec<Trade>)

Bbo(Bbo)

Candle(Candle)

AssetCtx

activeAssetCtx: a perp’s context.

Fields

§coin: String

§ctx: PerpCtx

SpotAssetCtx

activeSpotAssetCtx: what activeAssetCtx sends for a spot pair or an outcome side.

Fields

§coin: String

§ctx: SpotCtx

AssetData(ActiveAssetData)

activeAssetData.

UserFills(UserFills)

OrderUpdates(Vec<OrderUpdate>)

UserEvent(UserEvent)

user: what userEvents sends.

UserFundings(UserFundings)

Ledger(Ledger)

userNonFundingLedgerUpdates.

ClearinghouseState(DexState)

AllDexsClearinghouseState(AllDexsState)

OpenOrders(OpenOrders)

SpotState(SpotState)

TwapStates(TwapStates)

TwapSliceFills(TwapSliceFills)

userTwapSliceFills.

TwapHistory(TwapHistory)

userTwapHistory.

Notification(String)

WebData3(WebData3)

AllDexsAssetCtxs(Vec<(String, Vec<PerpCtx>)>)

Every perp dex’s contexts, by dex name, the first "".

AssetCtxs

Fields

§dex: String

§ctxs: Vec<PerpCtx>

SpotAssetCtxs(Vec<SpotCtx>)

OutcomeMetaUpdates(Json)

What changed in outcomeMeta, kept as sent: [{"outcomeSettled":23205}]. Its arrival is the news; read outcomeMeta again for the whole.

FastAssetCtxs(String)

fastAssetCtxs: base64 of raw DEFLATE (RFC 1951) over JSON, kept as sent. Inflating it needs a decompressor this crate does not carry.

HistoricalOrders(HistoricalOrders)

userHistoricalOrders.

Other

A channel this build does not read: its name, and its data as written (empty when the frame has none).

Fields

§channel: String

§data: String

Trait Implementations§

impl Clone for Frame

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Frame

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

Formats the value using the given formatter. Read more

impl Eq for Frame

impl PartialEq for Frame

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for Frame

Auto Trait Implementations§

impl Freeze for Frame

impl RefUnwindSafe for Frame

impl Send for Frame

impl Sync for Frame

impl Unpin for Frame

impl UnsafeUnpin for Frame

impl UnwindSafe for Frame

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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,

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

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

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

fn into(self) -> U

Calls U::from(self).

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

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,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more

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