Skip to main content

HyperliquidDataClientConfigBuilder

nautilus_hyperliquid::config

Struct HyperliquidDataClientConfigBuilder 

Source 
pub struct HyperliquidDataClientConfigBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> HyperliquidDataClientConfigBuilder<S>

Source

pub fn build(self) -> HyperliquidDataClientConfig
where S: IsComplete,

Finish building and return the requested object

Source

pub fn private_key( self, value: String, ) -> HyperliquidDataClientConfigBuilder<SetPrivateKey<S>>
where S::PrivateKey: IsUnset,

Optional (Some / Option setters). Optional private key for authenticated endpoints.

Source

pub fn maybe_private_key( self, value: Option<String>, ) -> HyperliquidDataClientConfigBuilder<SetPrivateKey<S>>
where S::PrivateKey: IsUnset,

Optional (Some / Option setters). Optional private key for authenticated endpoints.

Source

pub fn base_url_ws( self, value: String, ) -> HyperliquidDataClientConfigBuilder<SetBaseUrlWs<S>>
where S::BaseUrlWs: IsUnset,

Optional (Some / Option setters). Override for the WebSocket URL.

Source

pub fn maybe_base_url_ws( self, value: Option<String>, ) -> HyperliquidDataClientConfigBuilder<SetBaseUrlWs<S>>
where S::BaseUrlWs: IsUnset,

Optional (Some / Option setters). Override for the WebSocket URL.

Source

pub fn base_url_http( self, value: String, ) -> HyperliquidDataClientConfigBuilder<SetBaseUrlHttp<S>>
where S::BaseUrlHttp: IsUnset,

Optional (Some / Option setters). Override for the HTTP info URL.

Source

pub fn maybe_base_url_http( self, value: Option<String>, ) -> HyperliquidDataClientConfigBuilder<SetBaseUrlHttp<S>>
where S::BaseUrlHttp: IsUnset,

Optional (Some / Option setters). Override for the HTTP info URL.

Source

pub fn http_proxy_url( self, value: String, ) -> HyperliquidDataClientConfigBuilder<SetHttpProxyUrl<S>>
where S::HttpProxyUrl: IsUnset,

Optional (Some / Option setters). Optional HTTP proxy URL.

Source

pub fn maybe_http_proxy_url( self, value: Option<String>, ) -> HyperliquidDataClientConfigBuilder<SetHttpProxyUrl<S>>
where S::HttpProxyUrl: IsUnset,

Optional (Some / Option setters). Optional HTTP proxy URL.

Source

pub fn ws_proxy_url( self, value: String, ) -> HyperliquidDataClientConfigBuilder<SetWsProxyUrl<S>>
where S::WsProxyUrl: IsUnset,

Optional (Some / Option setters). Optional WebSocket proxy URL.

Note: WebSocket proxy support is not yet implemented. This field is reserved for future functionality. Use http_proxy_url for REST API proxy support.

Source

pub fn maybe_ws_proxy_url( self, value: Option<String>, ) -> HyperliquidDataClientConfigBuilder<SetWsProxyUrl<S>>
where S::WsProxyUrl: IsUnset,

Optional (Some / Option setters). Optional WebSocket proxy URL.

Note: WebSocket proxy support is not yet implemented. This field is reserved for future functionality. Use http_proxy_url for REST API proxy support.

Source

pub fn is_testnet( self, value: bool, ) -> HyperliquidDataClientConfigBuilder<SetIsTestnet<S>>
where S::IsTestnet: IsUnset,

Optional (Some / Option setters). Default: false.

When true the client will use Hyperliquid testnet endpoints.

Source

pub fn maybe_is_testnet( self, value: Option<bool>, ) -> HyperliquidDataClientConfigBuilder<SetIsTestnet<S>>
where S::IsTestnet: IsUnset,

Optional (Some / Option setters). Default: false.

When true the client will use Hyperliquid testnet endpoints.

Source

pub fn http_timeout_secs( self, value: u64, ) -> HyperliquidDataClientConfigBuilder<SetHttpTimeoutSecs<S>>
where S::HttpTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default: 60.

HTTP timeout in seconds.

Source

pub fn maybe_http_timeout_secs( self, value: Option<u64>, ) -> HyperliquidDataClientConfigBuilder<SetHttpTimeoutSecs<S>>
where S::HttpTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default: 60.

HTTP timeout in seconds.

Source

pub fn ws_timeout_secs( self, value: u64, ) -> HyperliquidDataClientConfigBuilder<SetWsTimeoutSecs<S>>
where S::WsTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default: 30.

WebSocket timeout in seconds.

Source

pub fn maybe_ws_timeout_secs( self, value: Option<u64>, ) -> HyperliquidDataClientConfigBuilder<SetWsTimeoutSecs<S>>
where S::WsTimeoutSecs: IsUnset,

Optional (Some / Option setters). Default: 30.

WebSocket timeout in seconds.

Source

pub fn update_instruments_interval_mins( self, value: u64, ) -> HyperliquidDataClientConfigBuilder<SetUpdateInstrumentsIntervalMins<S>>
where S::UpdateInstrumentsIntervalMins: IsUnset,

Optional (Some / Option setters). Default: 60.

Interval for refreshing instruments in minutes.

Source

pub fn maybe_update_instruments_interval_mins( self, value: Option<u64>, ) -> HyperliquidDataClientConfigBuilder<SetUpdateInstrumentsIntervalMins<S>>
where S::UpdateInstrumentsIntervalMins: IsUnset,

Optional (Some / Option setters). Default: 60.

Interval for refreshing instruments in minutes.

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

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

Source§

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