Skip to main content

Stream

hyperliquid_sdk::stream

Struct Stream 

Source 
pub struct Stream { /* private fields */ }
Expand description

WebSocket stream client

Implementations§

Source§

impl Stream

Source

pub fn new(endpoint: Option<String>) -> Self

Create a new stream client

Source

pub fn configure(self, config: StreamConfig) -> Self

Configure stream options

Source

pub fn on_error<F>(self, f: F) -> Self
where F: Fn(String) + Send + Sync + 'static,

Set error callback

Source

pub fn on_close<F>(self, f: F) -> Self
where F: Fn() + Send + Sync + 'static,

Set close callback

Source

pub fn on_open<F>(self, f: F) -> Self
where F: Fn() + Send + Sync + 'static,

Set open callback

Source

pub fn on_reconnect<F>(self, f: F) -> Self
where F: Fn(u32) + Send + Sync + 'static,

Set reconnect callback

Source

pub fn on_state_change<F>(self, f: F) -> Self
where F: Fn(ConnectionState) + Send + Sync + 'static,

Set state change callback

Source

pub fn state(&self) -> ConnectionState

Get current connection state

Source

pub fn connected(&self) -> bool

Check if connected

Source

pub fn reconnect_attempts(&self) -> u32

Get reconnect attempts

Source

pub fn trades<F>(&mut self, coins: &[&str], callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to trades

Source

pub fn orders<F>( &mut self, coins: &[&str], callback: F, users: Option<&[&str]>, ) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to orders

Source

pub fn book_updates<F>(&mut self, coins: &[&str], callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to book updates

Source

pub fn twap<F>(&mut self, coins: &[&str], callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to TWAP updates

Source

pub fn events<F>(&mut self, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to events

Source

pub fn l2_book<F>(&mut self, coin: &str, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to L2 order book

Source

pub fn all_mids<F>(&mut self, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to all mid prices

Source

pub fn candle<F>( &mut self, coin: &str, interval: &str, callback: F, ) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to candles

Source

pub fn open_orders<F>(&mut self, user: &str, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to user open orders

Source

pub fn order_updates<F>(&mut self, user: &str, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to order updates

Source

pub fn user_events<F>(&mut self, user: &str, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to user events

Source

pub fn user_fills<F>(&mut self, user: &str, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to user fills

Source

pub fn user_fundings<F>(&mut self, user: &str, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to user fundings

Source

pub fn user_non_funding_ledger<F>( &mut self, user: &str, callback: F, ) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to user non-funding ledger updates

Source

pub fn clearinghouse_state<F>( &mut self, user: &str, callback: F, ) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to clearinghouse state updates

Source

pub fn bbo<F>(&mut self, coin: &str, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to best bid/offer

Source

pub fn active_asset_ctx<F>(&mut self, coin: &str, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to active asset context

Source

pub fn active_asset_data<F>( &mut self, user: &str, coin: &str, callback: F, ) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to active asset data for a user

Source

pub fn twap_states<F>(&mut self, user: &str, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to TWAP states

Source

pub fn user_twap_slice_fills<F>( &mut self, user: &str, callback: F, ) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to user TWAP slice fills

Source

pub fn user_twap_history<F>(&mut self, user: &str, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to user TWAP history

Source

pub fn notification<F>(&mut self, user: &str, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to notifications

Source

pub fn web_data_3<F>(&mut self, user: &str, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to web data 3 (aggregate user info)

Source

pub fn writer_actions<F>(&mut self, callback: F) -> Subscription
where F: Fn(Value) + Send + Sync + 'static,

Subscribe to writer actions (spot token transfers)

Source

pub fn unsubscribe(&mut self, subscription: &Subscription)

Unsubscribe from a channel

Source

pub fn start(&mut self) -> Result<()>

Start the stream in background (non-blocking)

Source

pub async fn run(&mut self) -> Result<()>

Run the stream (blocking)

Source

pub fn stop(&mut self)

Stop the stream

Auto Trait Implementations§

Blanket Implementations§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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