Skip to main content

InteractiveBrokersDataClientConfigBuilder

nautilus_interactive_brokers::config

Struct InteractiveBrokersDataClientConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> InteractiveBrokersDataClientConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

pub fn host( self, value: String, ) -> InteractiveBrokersDataClientConfigBuilder<SetHost<S>>
where S::Host: IsUnset,

Optional (Some / Option setters). Default: DEFAULT_HOST.to_string().

Host for IB Gateway/TWS.

Source

pub fn maybe_host( self, value: Option<String>, ) -> InteractiveBrokersDataClientConfigBuilder<SetHost<S>>
where S::Host: IsUnset,

Optional (Some / Option setters). Default: DEFAULT_HOST.to_string().

Host for IB Gateway/TWS.

Source

pub fn port( self, value: u16, ) -> InteractiveBrokersDataClientConfigBuilder<SetPort<S>>
where S::Port: IsUnset,

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

Port for IB Gateway/TWS.

Source

pub fn maybe_port( self, value: Option<u16>, ) -> InteractiveBrokersDataClientConfigBuilder<SetPort<S>>
where S::Port: IsUnset,

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

Port for IB Gateway/TWS.

Source

pub fn client_id( self, value: i32, ) -> InteractiveBrokersDataClientConfigBuilder<SetClientId<S>>
where S::ClientId: IsUnset,

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

Client ID.

Source

pub fn maybe_client_id( self, value: Option<i32>, ) -> InteractiveBrokersDataClientConfigBuilder<SetClientId<S>>
where S::ClientId: IsUnset,

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

Client ID.

Source

pub fn use_regular_trading_hours( self, value: bool, ) -> InteractiveBrokersDataClientConfigBuilder<SetUseRegularTradingHours<S>>
where S::UseRegularTradingHours: IsUnset,

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

Whether to use regular trading hours only (RTH filtering).

Source

pub fn maybe_use_regular_trading_hours( self, value: Option<bool>, ) -> InteractiveBrokersDataClientConfigBuilder<SetUseRegularTradingHours<S>>
where S::UseRegularTradingHours: IsUnset,

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

Whether to use regular trading hours only (RTH filtering).

Source

pub fn market_data_type( self, value: MarketDataType, ) -> InteractiveBrokersDataClientConfigBuilder<SetMarketDataType<S>>
where S::MarketDataType: IsUnset,

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

Market data type (realtime, delayed, frozen).

Source

pub fn maybe_market_data_type( self, value: Option<MarketDataType>, ) -> InteractiveBrokersDataClientConfigBuilder<SetMarketDataType<S>>
where S::MarketDataType: IsUnset,

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

Market data type (realtime, delayed, frozen).

Source

pub fn ignore_quote_tick_size_updates( self, value: bool, ) -> InteractiveBrokersDataClientConfigBuilder<SetIgnoreQuoteTickSizeUpdates<S>>
where S::IgnoreQuoteTickSizeUpdates: IsUnset,

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

Whether to ignore quote tick size updates (filters size-only updates).

Source

pub fn maybe_ignore_quote_tick_size_updates( self, value: Option<bool>, ) -> InteractiveBrokersDataClientConfigBuilder<SetIgnoreQuoteTickSizeUpdates<S>>
where S::IgnoreQuoteTickSizeUpdates: IsUnset,

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

Whether to ignore quote tick size updates (filters size-only updates).

Source

pub fn connection_timeout( self, value: u64, ) -> InteractiveBrokersDataClientConfigBuilder<SetConnectionTimeout<S>>
where S::ConnectionTimeout: IsUnset,

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

Connection timeout in seconds.

Source

pub fn maybe_connection_timeout( self, value: Option<u64>, ) -> InteractiveBrokersDataClientConfigBuilder<SetConnectionTimeout<S>>
where S::ConnectionTimeout: IsUnset,

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

Connection timeout in seconds.

Source

pub fn request_timeout( self, value: u64, ) -> InteractiveBrokersDataClientConfigBuilder<SetRequestTimeout<S>>
where S::RequestTimeout: IsUnset,

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

Request timeout in seconds. Applied to IB API requests (open orders, executions, positions, account summary, order update stream, next order id). See execution/core.rs and execution/account.rs for call sites.

Source

pub fn maybe_request_timeout( self, value: Option<u64>, ) -> InteractiveBrokersDataClientConfigBuilder<SetRequestTimeout<S>>
where S::RequestTimeout: IsUnset,

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

Request timeout in seconds. Applied to IB API requests (open orders, executions, positions, account summary, order update stream, next order id). See execution/core.rs and execution/account.rs for call sites.

Source

pub fn handle_revised_bars( self, value: bool, ) -> InteractiveBrokersDataClientConfigBuilder<SetHandleRevisedBars<S>>
where S::HandleRevisedBars: IsUnset,

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

Whether to handle revised bars.

Source

pub fn maybe_handle_revised_bars( self, value: Option<bool>, ) -> InteractiveBrokersDataClientConfigBuilder<SetHandleRevisedBars<S>>
where S::HandleRevisedBars: IsUnset,

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

Whether to handle revised bars.

Source

pub fn batch_quotes( self, value: bool, ) -> InteractiveBrokersDataClientConfigBuilder<SetBatchQuotes<S>>
where S::BatchQuotes: IsUnset,

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

Whether to use batch quotes (reqMktData) by default instead of tick-by-tick.

Source

pub fn maybe_batch_quotes( self, value: Option<bool>, ) -> InteractiveBrokersDataClientConfigBuilder<SetBatchQuotes<S>>
where S::BatchQuotes: IsUnset,

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

Whether to use batch quotes (reqMktData) by default instead of tick-by-tick.

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.

§

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: 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: 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.
§

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
§

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

§

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