Skip to main content

InteractiveBrokersInstrumentProviderConfigBuilder

nautilus_interactive_brokers::config

Struct InteractiveBrokersInstrumentProviderConfigBuilder 

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

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

Implementations§

Source§

impl<S: State> InteractiveBrokersInstrumentProviderConfigBuilder<S>

Source

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

Finish building and return the requested object

Source

pub fn symbology_method( self, value: SymbologyMethod, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetSymbologyMethod<S>>
where S::SymbologyMethod: IsUnset,

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

Symbology method to use for instrument ID conversion.

Source

pub fn maybe_symbology_method( self, value: Option<SymbologyMethod>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetSymbologyMethod<S>>
where S::SymbologyMethod: IsUnset,

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

Symbology method to use for instrument ID conversion.

Source

pub fn load_ids( self, value: HashSet<InstrumentId>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetLoadIds<S>>
where S::LoadIds: IsUnset,

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

Instrument IDs to load on startup.

Source

pub fn maybe_load_ids( self, value: Option<HashSet<InstrumentId>>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetLoadIds<S>>
where S::LoadIds: IsUnset,

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

Instrument IDs to load on startup.

Source

pub fn load_contracts( self, value: Vec<Value>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetLoadContracts<S>>
where S::LoadContracts: IsUnset,

Optional (Some / Option setters). Default: <Vec<serde_json::Value> as Default>::default().

IB contracts to load on startup.

Source

pub fn maybe_load_contracts( self, value: Option<Vec<Value>>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetLoadContracts<S>>
where S::LoadContracts: IsUnset,

Optional (Some / Option setters). Default: <Vec<serde_json::Value> as Default>::default().

IB contracts to load on startup.

Source

pub fn min_expiry_days( self, value: u32, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetMinExpiryDays<S>>
where S::MinExpiryDays: IsUnset,

Optional (Some / Option setters). Minimum expiry days for options and futures chains.

Source

pub fn maybe_min_expiry_days( self, value: Option<u32>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetMinExpiryDays<S>>
where S::MinExpiryDays: IsUnset,

Optional (Some / Option setters). Minimum expiry days for options and futures chains.

Source

pub fn max_expiry_days( self, value: u32, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetMaxExpiryDays<S>>
where S::MaxExpiryDays: IsUnset,

Optional (Some / Option setters). Maximum expiry days for options and futures chains.

Source

pub fn maybe_max_expiry_days( self, value: Option<u32>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetMaxExpiryDays<S>>
where S::MaxExpiryDays: IsUnset,

Optional (Some / Option setters). Maximum expiry days for options and futures chains.

Source

pub fn build_options_chain( self, value: bool, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetBuildOptionsChain<S>>
where S::BuildOptionsChain: IsUnset,

Optional (Some / Option setters). Whether to build full options chain.

Source

pub fn maybe_build_options_chain( self, value: Option<bool>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetBuildOptionsChain<S>>
where S::BuildOptionsChain: IsUnset,

Optional (Some / Option setters). Whether to build full options chain.

Source

pub fn build_futures_chain( self, value: bool, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetBuildFuturesChain<S>>
where S::BuildFuturesChain: IsUnset,

Optional (Some / Option setters). Whether to build full futures chain.

Source

pub fn maybe_build_futures_chain( self, value: Option<bool>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetBuildFuturesChain<S>>
where S::BuildFuturesChain: IsUnset,

Optional (Some / Option setters). Whether to build full futures chain.

Source

pub fn cache_validity_days( self, value: u32, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetCacheValidityDays<S>>
where S::CacheValidityDays: IsUnset,

Optional (Some / Option setters). Cache validity in days (None means no caching).

Source

pub fn maybe_cache_validity_days( self, value: Option<u32>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetCacheValidityDays<S>>
where S::CacheValidityDays: IsUnset,

Optional (Some / Option setters). Cache validity in days (None means no caching).

Source

pub fn convert_exchange_to_mic_venue( self, value: bool, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetConvertExchangeToMicVenue<S>>
where S::ConvertExchangeToMicVenue: IsUnset,

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

Whether to convert IB exchanges to MIC venues.

Source

pub fn maybe_convert_exchange_to_mic_venue( self, value: Option<bool>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetConvertExchangeToMicVenue<S>>
where S::ConvertExchangeToMicVenue: IsUnset,

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

Whether to convert IB exchanges to MIC venues.

Source

pub fn symbol_to_mic_venue( self, value: HashMap<String, String>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetSymbolToMicVenue<S>>
where S::SymbolToMicVenue: IsUnset,

Optional (Some / Option setters). Default: <HashMap<String, String> as Default>::default().

Symbol to MIC venue mapping override.

Source

pub fn maybe_symbol_to_mic_venue( self, value: Option<HashMap<String, String>>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetSymbolToMicVenue<S>>
where S::SymbolToMicVenue: IsUnset,

Optional (Some / Option setters). Default: <HashMap<String, String> as Default>::default().

Symbol to MIC venue mapping override.

Source

pub fn filter_sec_types( self, value: HashSet<String>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetFilterSecTypes<S>>
where S::FilterSecTypes: IsUnset,

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

Security types to filter out.

Source

pub fn maybe_filter_sec_types( self, value: Option<HashSet<String>>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetFilterSecTypes<S>>
where S::FilterSecTypes: IsUnset,

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

Security types to filter out.

Source

pub fn cache_path( self, value: String, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetCachePath<S>>
where S::CachePath: IsUnset,

Optional (Some / Option setters). Path to cache file for persistent instrument caching (equivalent to pickle_path in Python). If provided, instruments will be cached to disk and loaded from cache if still valid.

Source

pub fn maybe_cache_path( self, value: Option<String>, ) -> InteractiveBrokersInstrumentProviderConfigBuilder<SetCachePath<S>>
where S::CachePath: IsUnset,

Optional (Some / Option setters). Path to cache file for persistent instrument caching (equivalent to pickle_path in Python). If provided, instruments will be cached to disk and loaded from cache if still valid.

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,