Skip to main content

BybitExecutionClientConfigBuilder

Struct BybitExecutionClientConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> BybitExecutionClientConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

pub fn api_key( self, value: String, ) -> BybitExecutionClientConfigBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

Optional (Some / Option setters). API key for authenticated requests.

Source

pub fn maybe_api_key( self, value: Option<String>, ) -> BybitExecutionClientConfigBuilder<SetApiKey<S>>
where S::ApiKey: IsUnset,

Optional (Some / Option setters). API key for authenticated requests.

Source

pub fn api_secret( self, value: String, ) -> BybitExecutionClientConfigBuilder<SetApiSecret<S>>
where S::ApiSecret: IsUnset,

Optional (Some / Option setters). API secret for authenticated requests.

Source

pub fn maybe_api_secret( self, value: Option<String>, ) -> BybitExecutionClientConfigBuilder<SetApiSecret<S>>
where S::ApiSecret: IsUnset,

Optional (Some / Option setters). API secret for authenticated requests.

Source

pub fn product_types( self, value: Vec<BybitProductType>, ) -> BybitExecutionClientConfigBuilder<SetProductTypes<S>>
where S::ProductTypes: IsUnset,

Optional (Some / Option setters). Default: vec![BybitProductType::Linear].

Product types to support (e.g., Linear, Spot, Inverse, Option).

Source

pub fn maybe_product_types( self, value: Option<Vec<BybitProductType>>, ) -> BybitExecutionClientConfigBuilder<SetProductTypes<S>>
where S::ProductTypes: IsUnset,

Optional (Some / Option setters). Default: vec![BybitProductType::Linear].

Product types to support (e.g., Linear, Spot, Inverse, Option).

Source

pub fn environment( self, value: BybitEnvironment, ) -> BybitExecutionClientConfigBuilder<SetEnvironment<S>>
where S::Environment: IsUnset,

Optional (Some / Option setters). Default: BybitEnvironment::Mainnet.

Environment selection (Mainnet, Testnet, Demo).

Source

pub fn maybe_environment( self, value: Option<BybitEnvironment>, ) -> BybitExecutionClientConfigBuilder<SetEnvironment<S>>
where S::Environment: IsUnset,

Optional (Some / Option setters). Default: BybitEnvironment::Mainnet.

Environment selection (Mainnet, Testnet, Demo).

Source

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

Optional (Some / Option setters). Optional override for the REST base URL.

Source

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

Optional (Some / Option setters). Optional override for the REST base URL.

Source

pub fn base_url_ws_private( self, value: String, ) -> BybitExecutionClientConfigBuilder<SetBaseUrlWsPrivate<S>>
where S::BaseUrlWsPrivate: IsUnset,

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

Source

pub fn maybe_base_url_ws_private( self, value: Option<String>, ) -> BybitExecutionClientConfigBuilder<SetBaseUrlWsPrivate<S>>
where S::BaseUrlWsPrivate: IsUnset,

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

Source

pub fn base_url_ws_trade( self, value: String, ) -> BybitExecutionClientConfigBuilder<SetBaseUrlWsTrade<S>>
where S::BaseUrlWsTrade: IsUnset,

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

Source

pub fn maybe_base_url_ws_trade( self, value: Option<String>, ) -> BybitExecutionClientConfigBuilder<SetBaseUrlWsTrade<S>>
where S::BaseUrlWsTrade: IsUnset,

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

Source

pub fn proxy_url( self, value: String, ) -> BybitExecutionClientConfigBuilder<SetProxyUrl<S>>
where S::ProxyUrl: IsUnset,

Optional (Some / Option setters). Optional proxy URL for HTTP and WebSocket transports.

Source

pub fn maybe_proxy_url( self, value: Option<String>, ) -> BybitExecutionClientConfigBuilder<SetProxyUrl<S>>
where S::ProxyUrl: IsUnset,

Optional (Some / Option setters). Optional proxy URL for HTTP and WebSocket transports.

Source

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

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

REST timeout in seconds.

Source

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

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

REST timeout in seconds.

Source

pub fn max_retries( self, value: u32, ) -> BybitExecutionClientConfigBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

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

Maximum retry attempts for REST requests.

Source

pub fn maybe_max_retries( self, value: Option<u32>, ) -> BybitExecutionClientConfigBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

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

Maximum retry attempts for REST requests.

Source

pub fn retry_delay_initial_ms( self, value: u64, ) -> BybitExecutionClientConfigBuilder<SetRetryDelayInitialMs<S>>
where S::RetryDelayInitialMs: IsUnset,

Optional (Some / Option setters). Default: 1_000.

Initial retry backoff in milliseconds.

Source

pub fn maybe_retry_delay_initial_ms( self, value: Option<u64>, ) -> BybitExecutionClientConfigBuilder<SetRetryDelayInitialMs<S>>
where S::RetryDelayInitialMs: IsUnset,

Optional (Some / Option setters). Default: 1_000.

Initial retry backoff in milliseconds.

Source

pub fn retry_delay_max_ms( self, value: u64, ) -> BybitExecutionClientConfigBuilder<SetRetryDelayMaxMs<S>>
where S::RetryDelayMaxMs: IsUnset,

Optional (Some / Option setters). Default: 10_000.

Maximum retry backoff in milliseconds.

Source

pub fn maybe_retry_delay_max_ms( self, value: Option<u64>, ) -> BybitExecutionClientConfigBuilder<SetRetryDelayMaxMs<S>>
where S::RetryDelayMaxMs: IsUnset,

Optional (Some / Option setters). Default: 10_000.

Maximum retry backoff in milliseconds.

Source

pub fn heartbeat_interval_secs( self, value: u64, ) -> BybitExecutionClientConfigBuilder<SetHeartbeatIntervalSecs<S>>
where S::HeartbeatIntervalSecs: IsUnset,

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

Heartbeat interval in seconds for WebSocket clients.

Source

pub fn maybe_heartbeat_interval_secs( self, value: Option<u64>, ) -> BybitExecutionClientConfigBuilder<SetHeartbeatIntervalSecs<S>>
where S::HeartbeatIntervalSecs: IsUnset,

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

Heartbeat interval in seconds for WebSocket clients.

Source

pub fn auth_timeout_secs( self, value: u64, ) -> BybitExecutionClientConfigBuilder<SetAuthTimeoutSecs<S>>
where S::AuthTimeoutSecs: IsUnset,

Optional (Some / Option setters). Optional WebSocket authentication wait timeout (seconds), defaulting to the client default when unset.

Source

pub fn maybe_auth_timeout_secs( self, value: Option<u64>, ) -> BybitExecutionClientConfigBuilder<SetAuthTimeoutSecs<S>>
where S::AuthTimeoutSecs: IsUnset,

Optional (Some / Option setters). Optional WebSocket authentication wait timeout (seconds), defaulting to the client default when unset.

Source

pub fn recv_window_ms( self, value: u64, ) -> BybitExecutionClientConfigBuilder<SetRecvWindowMs<S>>
where S::RecvWindowMs: IsUnset,

Optional (Some / Option setters). Default: 5_000.

Receive window in milliseconds for signed requests.

Source

pub fn maybe_recv_window_ms( self, value: Option<u64>, ) -> BybitExecutionClientConfigBuilder<SetRecvWindowMs<S>>
where S::RecvWindowMs: IsUnset,

Optional (Some / Option setters). Default: 5_000.

Receive window in milliseconds for signed requests.

Source

pub fn account_id( self, value: AccountId, ) -> BybitExecutionClientConfigBuilder<SetAccountId<S>>
where S::AccountId: IsUnset,

Optional (Some / Option setters). Optional account identifier to associate with the execution client.

Source

pub fn maybe_account_id( self, value: Option<AccountId>, ) -> BybitExecutionClientConfigBuilder<SetAccountId<S>>
where S::AccountId: IsUnset,

Optional (Some / Option setters). Optional account identifier to associate with the execution client.

Source

pub fn use_spot_position_reports( self, value: bool, ) -> BybitExecutionClientConfigBuilder<SetUseSpotPositionReports<S>>
where S::UseSpotPositionReports: IsUnset,

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

Whether scoped execution-client SPOT position requests derive positions from wallet balances. The HTTP client rejects enabled unscoped SPOT requests because balances cannot be attributed to pairs. The execution client omits SPOT from bulk requests and reports its bulk coverage as unavailable.

Source

pub fn maybe_use_spot_position_reports( self, value: Option<bool>, ) -> BybitExecutionClientConfigBuilder<SetUseSpotPositionReports<S>>
where S::UseSpotPositionReports: IsUnset,

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

Whether scoped execution-client SPOT position requests derive positions from wallet balances. The HTTP client rejects enabled unscoped SPOT requests because balances cannot be attributed to pairs. The execution client omits SPOT from bulk requests and reports its bulk coverage as unavailable.

Source

pub fn auto_repay_spot_borrows( self, value: bool, ) -> BybitExecutionClientConfigBuilder<SetAutoRepaySpotBorrows<S>>
where S::AutoRepaySpotBorrows: IsUnset,

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

Whether to automatically repay SPOT margin borrows after BUY orders tracked by this client and reported on the standard execution channel (not execution.fast) fully fill.

Source

pub fn maybe_auto_repay_spot_borrows( self, value: Option<bool>, ) -> BybitExecutionClientConfigBuilder<SetAutoRepaySpotBorrows<S>>
where S::AutoRepaySpotBorrows: IsUnset,

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

Whether to automatically repay SPOT margin borrows after BUY orders tracked by this client and reported on the standard execution channel (not execution.fast) fully fill.

Source

pub fn futures_leverages( self, value: HashMap<String, u32>, ) -> BybitExecutionClientConfigBuilder<SetFuturesLeverages<S>>
where S::FuturesLeverages: IsUnset,

Optional (Some / Option setters). Leverage configuration for futures (symbol -> leverage).

Source

pub fn maybe_futures_leverages( self, value: Option<HashMap<String, u32>>, ) -> BybitExecutionClientConfigBuilder<SetFuturesLeverages<S>>
where S::FuturesLeverages: IsUnset,

Optional (Some / Option setters). Leverage configuration for futures (symbol -> leverage).

Source

pub fn position_mode( self, value: HashMap<String, BybitPositionMode>, ) -> BybitExecutionClientConfigBuilder<SetPositionMode<S>>
where S::PositionMode: IsUnset,

Optional (Some / Option setters). Position mode configuration for symbols (symbol -> mode).

Source

pub fn maybe_position_mode( self, value: Option<HashMap<String, BybitPositionMode>>, ) -> BybitExecutionClientConfigBuilder<SetPositionMode<S>>
where S::PositionMode: IsUnset,

Optional (Some / Option setters). Position mode configuration for symbols (symbol -> mode).

Source

pub fn margin_mode( self, value: BybitMarginMode, ) -> BybitExecutionClientConfigBuilder<SetMarginMode<S>>
where S::MarginMode: IsUnset,

Optional (Some / Option setters). Unified margin mode setting.

Source

pub fn maybe_margin_mode( self, value: Option<BybitMarginMode>, ) -> BybitExecutionClientConfigBuilder<SetMarginMode<S>>
where S::MarginMode: IsUnset,

Optional (Some / Option setters). Unified margin mode setting.

Source

pub fn transport_backend( self, value: TransportBackend, ) -> BybitExecutionClientConfigBuilder<SetTransportBackend<S>>
where S::TransportBackend: IsUnset,

Optional (Some / Option setters). Default: <TransportBackend as Default>::default().

WebSocket transport backend (defaults to Tungstenite).

Source

pub fn maybe_transport_backend( self, value: Option<TransportBackend>, ) -> BybitExecutionClientConfigBuilder<SetTransportBackend<S>>
where S::TransportBackend: IsUnset,

Optional (Some / Option setters). Default: <TransportBackend as Default>::default().

WebSocket transport backend (defaults to Tungstenite).

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 = !

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