pub struct BitmexExecClientConfigBuilder<S: State = Empty> { /* private fields */ }Expand description
Use builder syntax to set the inputs and finish with build().
Implementations§
Source§impl<S: State> BitmexExecClientConfigBuilder<S>
impl<S: State> BitmexExecClientConfigBuilder<S>
Sourcepub fn build(self) -> BitmexExecClientConfigwhere
S: IsComplete,
pub fn build(self) -> BitmexExecClientConfigwhere
S: IsComplete,
Finish building and return the requested object
Sourcepub fn api_key(
self,
value: String,
) -> BitmexExecClientConfigBuilder<SetApiKey<S>>where
S::ApiKey: IsUnset,
pub fn api_key(
self,
value: String,
) -> BitmexExecClientConfigBuilder<SetApiKey<S>>where
S::ApiKey: IsUnset,
Sourcepub fn maybe_api_key(
self,
value: Option<String>,
) -> BitmexExecClientConfigBuilder<SetApiKey<S>>where
S::ApiKey: IsUnset,
pub fn maybe_api_key(
self,
value: Option<String>,
) -> BitmexExecClientConfigBuilder<SetApiKey<S>>where
S::ApiKey: IsUnset,
Sourcepub fn api_secret(
self,
value: String,
) -> BitmexExecClientConfigBuilder<SetApiSecret<S>>where
S::ApiSecret: IsUnset,
pub fn api_secret(
self,
value: String,
) -> BitmexExecClientConfigBuilder<SetApiSecret<S>>where
S::ApiSecret: IsUnset,
Sourcepub fn maybe_api_secret(
self,
value: Option<String>,
) -> BitmexExecClientConfigBuilder<SetApiSecret<S>>where
S::ApiSecret: IsUnset,
pub fn maybe_api_secret(
self,
value: Option<String>,
) -> BitmexExecClientConfigBuilder<SetApiSecret<S>>where
S::ApiSecret: IsUnset,
Sourcepub fn base_url_http(
self,
value: String,
) -> BitmexExecClientConfigBuilder<SetBaseUrlHttp<S>>where
S::BaseUrlHttp: IsUnset,
pub fn base_url_http(
self,
value: String,
) -> BitmexExecClientConfigBuilder<SetBaseUrlHttp<S>>where
S::BaseUrlHttp: IsUnset,
Sourcepub fn maybe_base_url_http(
self,
value: Option<String>,
) -> BitmexExecClientConfigBuilder<SetBaseUrlHttp<S>>where
S::BaseUrlHttp: IsUnset,
pub fn maybe_base_url_http(
self,
value: Option<String>,
) -> BitmexExecClientConfigBuilder<SetBaseUrlHttp<S>>where
S::BaseUrlHttp: IsUnset,
Sourcepub fn base_url_ws(
self,
value: String,
) -> BitmexExecClientConfigBuilder<SetBaseUrlWs<S>>where
S::BaseUrlWs: IsUnset,
pub fn base_url_ws(
self,
value: String,
) -> BitmexExecClientConfigBuilder<SetBaseUrlWs<S>>where
S::BaseUrlWs: IsUnset,
Sourcepub fn maybe_base_url_ws(
self,
value: Option<String>,
) -> BitmexExecClientConfigBuilder<SetBaseUrlWs<S>>where
S::BaseUrlWs: IsUnset,
pub fn maybe_base_url_ws(
self,
value: Option<String>,
) -> BitmexExecClientConfigBuilder<SetBaseUrlWs<S>>where
S::BaseUrlWs: IsUnset,
Sourcepub fn proxy_url(
self,
value: String,
) -> BitmexExecClientConfigBuilder<SetProxyUrl<S>>where
S::ProxyUrl: IsUnset,
pub fn proxy_url(
self,
value: String,
) -> BitmexExecClientConfigBuilder<SetProxyUrl<S>>where
S::ProxyUrl: IsUnset,
Sourcepub fn maybe_proxy_url(
self,
value: Option<String>,
) -> BitmexExecClientConfigBuilder<SetProxyUrl<S>>where
S::ProxyUrl: IsUnset,
pub fn maybe_proxy_url(
self,
value: Option<String>,
) -> BitmexExecClientConfigBuilder<SetProxyUrl<S>>where
S::ProxyUrl: IsUnset,
Sourcepub fn http_timeout_secs(
self,
value: u64,
) -> BitmexExecClientConfigBuilder<SetHttpTimeoutSecs<S>>where
S::HttpTimeoutSecs: IsUnset,
pub fn http_timeout_secs(
self,
value: u64,
) -> BitmexExecClientConfigBuilder<SetHttpTimeoutSecs<S>>where
S::HttpTimeoutSecs: IsUnset,
Sourcepub fn maybe_http_timeout_secs(
self,
value: Option<u64>,
) -> BitmexExecClientConfigBuilder<SetHttpTimeoutSecs<S>>where
S::HttpTimeoutSecs: IsUnset,
pub fn maybe_http_timeout_secs(
self,
value: Option<u64>,
) -> BitmexExecClientConfigBuilder<SetHttpTimeoutSecs<S>>where
S::HttpTimeoutSecs: IsUnset,
Sourcepub fn max_retries(
self,
value: u32,
) -> BitmexExecClientConfigBuilder<SetMaxRetries<S>>where
S::MaxRetries: IsUnset,
pub fn max_retries(
self,
value: u32,
) -> BitmexExecClientConfigBuilder<SetMaxRetries<S>>where
S::MaxRetries: IsUnset,
Sourcepub fn maybe_max_retries(
self,
value: Option<u32>,
) -> BitmexExecClientConfigBuilder<SetMaxRetries<S>>where
S::MaxRetries: IsUnset,
pub fn maybe_max_retries(
self,
value: Option<u32>,
) -> BitmexExecClientConfigBuilder<SetMaxRetries<S>>where
S::MaxRetries: IsUnset,
Sourcepub fn retry_delay_initial_ms(
self,
value: u64,
) -> BitmexExecClientConfigBuilder<SetRetryDelayInitialMs<S>>where
S::RetryDelayInitialMs: IsUnset,
pub fn retry_delay_initial_ms(
self,
value: u64,
) -> BitmexExecClientConfigBuilder<SetRetryDelayInitialMs<S>>where
S::RetryDelayInitialMs: IsUnset,
Sourcepub fn maybe_retry_delay_initial_ms(
self,
value: Option<u64>,
) -> BitmexExecClientConfigBuilder<SetRetryDelayInitialMs<S>>where
S::RetryDelayInitialMs: IsUnset,
pub fn maybe_retry_delay_initial_ms(
self,
value: Option<u64>,
) -> BitmexExecClientConfigBuilder<SetRetryDelayInitialMs<S>>where
S::RetryDelayInitialMs: IsUnset,
Sourcepub fn retry_delay_max_ms(
self,
value: u64,
) -> BitmexExecClientConfigBuilder<SetRetryDelayMaxMs<S>>where
S::RetryDelayMaxMs: IsUnset,
pub fn retry_delay_max_ms(
self,
value: u64,
) -> BitmexExecClientConfigBuilder<SetRetryDelayMaxMs<S>>where
S::RetryDelayMaxMs: IsUnset,
Sourcepub fn maybe_retry_delay_max_ms(
self,
value: Option<u64>,
) -> BitmexExecClientConfigBuilder<SetRetryDelayMaxMs<S>>where
S::RetryDelayMaxMs: IsUnset,
pub fn maybe_retry_delay_max_ms(
self,
value: Option<u64>,
) -> BitmexExecClientConfigBuilder<SetRetryDelayMaxMs<S>>where
S::RetryDelayMaxMs: IsUnset,
Sourcepub fn heartbeat_interval_secs(
self,
value: u64,
) -> BitmexExecClientConfigBuilder<SetHeartbeatIntervalSecs<S>>where
S::HeartbeatIntervalSecs: IsUnset,
pub fn heartbeat_interval_secs(
self,
value: u64,
) -> BitmexExecClientConfigBuilder<SetHeartbeatIntervalSecs<S>>where
S::HeartbeatIntervalSecs: IsUnset,
Sourcepub fn maybe_heartbeat_interval_secs(
self,
value: Option<u64>,
) -> BitmexExecClientConfigBuilder<SetHeartbeatIntervalSecs<S>>where
S::HeartbeatIntervalSecs: IsUnset,
pub fn maybe_heartbeat_interval_secs(
self,
value: Option<u64>,
) -> BitmexExecClientConfigBuilder<SetHeartbeatIntervalSecs<S>>where
S::HeartbeatIntervalSecs: IsUnset,
Sourcepub fn recv_window_ms(
self,
value: u64,
) -> BitmexExecClientConfigBuilder<SetRecvWindowMs<S>>where
S::RecvWindowMs: IsUnset,
pub fn recv_window_ms(
self,
value: u64,
) -> BitmexExecClientConfigBuilder<SetRecvWindowMs<S>>where
S::RecvWindowMs: IsUnset,
Optional (Some / Option setters).
Default: 10_000.
Receive window in milliseconds for signed requests.
This value determines how far in the future the api-expires timestamp will be set
for signed REST requests. BitMEX uses seconds-granularity Unix timestamps in the
api-expires header, calculated as: current_timestamp + (recv_window_ms / 1000).
Note: This parameter is specified in milliseconds for consistency with other
adapter configurations (e.g., Bybit’s recv_window_ms), but BitMEX only supports
seconds-granularity timestamps. The value is converted via integer division, so
10000ms becomes 10 seconds, 15500ms becomes 15 seconds, etc.
A larger window provides more tolerance for clock skew and network latency, but increases the replay attack window. The default of 10 seconds should be sufficient for most deployments. Consider increasing this value (e.g., to 30000ms = 30s) if you experience request expiration errors due to clock drift or high network latency.
Sourcepub fn maybe_recv_window_ms(
self,
value: Option<u64>,
) -> BitmexExecClientConfigBuilder<SetRecvWindowMs<S>>where
S::RecvWindowMs: IsUnset,
pub fn maybe_recv_window_ms(
self,
value: Option<u64>,
) -> BitmexExecClientConfigBuilder<SetRecvWindowMs<S>>where
S::RecvWindowMs: IsUnset,
Optional (Some / Option setters).
Default: 10_000.
Receive window in milliseconds for signed requests.
This value determines how far in the future the api-expires timestamp will be set
for signed REST requests. BitMEX uses seconds-granularity Unix timestamps in the
api-expires header, calculated as: current_timestamp + (recv_window_ms / 1000).
Note: This parameter is specified in milliseconds for consistency with other
adapter configurations (e.g., Bybit’s recv_window_ms), but BitMEX only supports
seconds-granularity timestamps. The value is converted via integer division, so
10000ms becomes 10 seconds, 15500ms becomes 15 seconds, etc.
A larger window provides more tolerance for clock skew and network latency, but increases the replay attack window. The default of 10 seconds should be sufficient for most deployments. Consider increasing this value (e.g., to 30000ms = 30s) if you experience request expiration errors due to clock drift or high network latency.
Sourcepub fn active_only(
self,
value: bool,
) -> BitmexExecClientConfigBuilder<SetActiveOnly<S>>where
S::ActiveOnly: IsUnset,
pub fn active_only(
self,
value: bool,
) -> BitmexExecClientConfigBuilder<SetActiveOnly<S>>where
S::ActiveOnly: IsUnset,
Sourcepub fn maybe_active_only(
self,
value: Option<bool>,
) -> BitmexExecClientConfigBuilder<SetActiveOnly<S>>where
S::ActiveOnly: IsUnset,
pub fn maybe_active_only(
self,
value: Option<bool>,
) -> BitmexExecClientConfigBuilder<SetActiveOnly<S>>where
S::ActiveOnly: IsUnset,
Sourcepub fn environment(
self,
value: BitmexEnvironment,
) -> BitmexExecClientConfigBuilder<SetEnvironment<S>>where
S::Environment: IsUnset,
pub fn environment(
self,
value: BitmexEnvironment,
) -> BitmexExecClientConfigBuilder<SetEnvironment<S>>where
S::Environment: IsUnset,
Sourcepub fn maybe_environment(
self,
value: Option<BitmexEnvironment>,
) -> BitmexExecClientConfigBuilder<SetEnvironment<S>>where
S::Environment: IsUnset,
pub fn maybe_environment(
self,
value: Option<BitmexEnvironment>,
) -> BitmexExecClientConfigBuilder<SetEnvironment<S>>where
S::Environment: IsUnset,
Sourcepub fn account_id(
self,
value: AccountId,
) -> BitmexExecClientConfigBuilder<SetAccountId<S>>where
S::AccountId: IsUnset,
pub fn account_id(
self,
value: AccountId,
) -> BitmexExecClientConfigBuilder<SetAccountId<S>>where
S::AccountId: IsUnset,
Sourcepub fn maybe_account_id(
self,
value: Option<AccountId>,
) -> BitmexExecClientConfigBuilder<SetAccountId<S>>where
S::AccountId: IsUnset,
pub fn maybe_account_id(
self,
value: Option<AccountId>,
) -> BitmexExecClientConfigBuilder<SetAccountId<S>>where
S::AccountId: IsUnset,
Sourcepub fn max_requests_per_second(
self,
value: u32,
) -> BitmexExecClientConfigBuilder<SetMaxRequestsPerSecond<S>>where
S::MaxRequestsPerSecond: IsUnset,
pub fn max_requests_per_second(
self,
value: u32,
) -> BitmexExecClientConfigBuilder<SetMaxRequestsPerSecond<S>>where
S::MaxRequestsPerSecond: IsUnset,
Sourcepub fn maybe_max_requests_per_second(
self,
value: Option<u32>,
) -> BitmexExecClientConfigBuilder<SetMaxRequestsPerSecond<S>>where
S::MaxRequestsPerSecond: IsUnset,
pub fn maybe_max_requests_per_second(
self,
value: Option<u32>,
) -> BitmexExecClientConfigBuilder<SetMaxRequestsPerSecond<S>>where
S::MaxRequestsPerSecond: IsUnset,
Sourcepub fn max_requests_per_minute(
self,
value: u32,
) -> BitmexExecClientConfigBuilder<SetMaxRequestsPerMinute<S>>where
S::MaxRequestsPerMinute: IsUnset,
pub fn max_requests_per_minute(
self,
value: u32,
) -> BitmexExecClientConfigBuilder<SetMaxRequestsPerMinute<S>>where
S::MaxRequestsPerMinute: IsUnset,
Sourcepub fn maybe_max_requests_per_minute(
self,
value: Option<u32>,
) -> BitmexExecClientConfigBuilder<SetMaxRequestsPerMinute<S>>where
S::MaxRequestsPerMinute: IsUnset,
pub fn maybe_max_requests_per_minute(
self,
value: Option<u32>,
) -> BitmexExecClientConfigBuilder<SetMaxRequestsPerMinute<S>>where
S::MaxRequestsPerMinute: IsUnset,
Sourcepub fn submitter_pool_size(
self,
value: usize,
) -> BitmexExecClientConfigBuilder<SetSubmitterPoolSize<S>>where
S::SubmitterPoolSize: IsUnset,
pub fn submitter_pool_size(
self,
value: usize,
) -> BitmexExecClientConfigBuilder<SetSubmitterPoolSize<S>>where
S::SubmitterPoolSize: IsUnset,
Sourcepub fn maybe_submitter_pool_size(
self,
value: Option<usize>,
) -> BitmexExecClientConfigBuilder<SetSubmitterPoolSize<S>>where
S::SubmitterPoolSize: IsUnset,
pub fn maybe_submitter_pool_size(
self,
value: Option<usize>,
) -> BitmexExecClientConfigBuilder<SetSubmitterPoolSize<S>>where
S::SubmitterPoolSize: IsUnset,
Sourcepub fn canceller_pool_size(
self,
value: usize,
) -> BitmexExecClientConfigBuilder<SetCancellerPoolSize<S>>where
S::CancellerPoolSize: IsUnset,
pub fn canceller_pool_size(
self,
value: usize,
) -> BitmexExecClientConfigBuilder<SetCancellerPoolSize<S>>where
S::CancellerPoolSize: IsUnset,
Sourcepub fn maybe_canceller_pool_size(
self,
value: Option<usize>,
) -> BitmexExecClientConfigBuilder<SetCancellerPoolSize<S>>where
S::CancellerPoolSize: IsUnset,
pub fn maybe_canceller_pool_size(
self,
value: Option<usize>,
) -> BitmexExecClientConfigBuilder<SetCancellerPoolSize<S>>where
S::CancellerPoolSize: IsUnset,
Sourcepub fn submitter_proxy_urls(
self,
value: Vec<String>,
) -> BitmexExecClientConfigBuilder<SetSubmitterProxyUrls<S>>where
S::SubmitterProxyUrls: IsUnset,
pub fn submitter_proxy_urls(
self,
value: Vec<String>,
) -> BitmexExecClientConfigBuilder<SetSubmitterProxyUrls<S>>where
S::SubmitterProxyUrls: IsUnset,
Sourcepub fn maybe_submitter_proxy_urls(
self,
value: Option<Vec<String>>,
) -> BitmexExecClientConfigBuilder<SetSubmitterProxyUrls<S>>where
S::SubmitterProxyUrls: IsUnset,
pub fn maybe_submitter_proxy_urls(
self,
value: Option<Vec<String>>,
) -> BitmexExecClientConfigBuilder<SetSubmitterProxyUrls<S>>where
S::SubmitterProxyUrls: IsUnset,
Sourcepub fn canceller_proxy_urls(
self,
value: Vec<String>,
) -> BitmexExecClientConfigBuilder<SetCancellerProxyUrls<S>>where
S::CancellerProxyUrls: IsUnset,
pub fn canceller_proxy_urls(
self,
value: Vec<String>,
) -> BitmexExecClientConfigBuilder<SetCancellerProxyUrls<S>>where
S::CancellerProxyUrls: IsUnset,
Sourcepub fn maybe_canceller_proxy_urls(
self,
value: Option<Vec<String>>,
) -> BitmexExecClientConfigBuilder<SetCancellerProxyUrls<S>>where
S::CancellerProxyUrls: IsUnset,
pub fn maybe_canceller_proxy_urls(
self,
value: Option<Vec<String>>,
) -> BitmexExecClientConfigBuilder<SetCancellerProxyUrls<S>>where
S::CancellerProxyUrls: IsUnset,
Sourcepub fn deadmans_switch_timeout_secs(
self,
value: u64,
) -> BitmexExecClientConfigBuilder<SetDeadmansSwitchTimeoutSecs<S>>where
S::DeadmansSwitchTimeoutSecs: IsUnset,
pub fn deadmans_switch_timeout_secs(
self,
value: u64,
) -> BitmexExecClientConfigBuilder<SetDeadmansSwitchTimeoutSecs<S>>where
S::DeadmansSwitchTimeoutSecs: IsUnset,
Optional (Some / Option setters). Optional dead man’s switch timeout in seconds.
When set, a background task periodically calls the BitMEX cancelAllAfter endpoint
to keep a server-side timer alive. If the client loses connectivity the timer expires
and BitMEX cancels all open orders. Calling with timeout=0 disarms the switch.
The refresh interval is derived as timeout / 4 (minimum 1 second).
Sourcepub fn maybe_deadmans_switch_timeout_secs(
self,
value: Option<u64>,
) -> BitmexExecClientConfigBuilder<SetDeadmansSwitchTimeoutSecs<S>>where
S::DeadmansSwitchTimeoutSecs: IsUnset,
pub fn maybe_deadmans_switch_timeout_secs(
self,
value: Option<u64>,
) -> BitmexExecClientConfigBuilder<SetDeadmansSwitchTimeoutSecs<S>>where
S::DeadmansSwitchTimeoutSecs: IsUnset,
Optional (Some / Option setters). Optional dead man’s switch timeout in seconds.
When set, a background task periodically calls the BitMEX cancelAllAfter endpoint
to keep a server-side timer alive. If the client loses connectivity the timer expires
and BitMEX cancels all open orders. Calling with timeout=0 disarms the switch.
The refresh interval is derived as timeout / 4 (minimum 1 second).
Sourcepub fn transport_backend(
self,
value: TransportBackend,
) -> BitmexExecClientConfigBuilder<SetTransportBackend<S>>where
S::TransportBackend: IsUnset,
pub fn transport_backend(
self,
value: TransportBackend,
) -> BitmexExecClientConfigBuilder<SetTransportBackend<S>>where
S::TransportBackend: IsUnset,
Sourcepub fn maybe_transport_backend(
self,
value: Option<TransportBackend>,
) -> BitmexExecClientConfigBuilder<SetTransportBackend<S>>where
S::TransportBackend: IsUnset,
pub fn maybe_transport_backend(
self,
value: Option<TransportBackend>,
) -> BitmexExecClientConfigBuilder<SetTransportBackend<S>>where
S::TransportBackend: IsUnset,
Auto Trait Implementations§
impl<S> Freeze for BitmexExecClientConfigBuilder<S>
impl<S> RefUnwindSafe for BitmexExecClientConfigBuilder<S>
impl<S> Send for BitmexExecClientConfigBuilder<S>
impl<S> Sync for BitmexExecClientConfigBuilder<S>
impl<S> Unpin for BitmexExecClientConfigBuilder<S>
impl<S> UnsafeUnpin for BitmexExecClientConfigBuilder<S>
impl<S> UnwindSafe for BitmexExecClientConfigBuilder<S>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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