Struct InteractiveBrokersExecutionClientConfig 

pub struct InteractiveBrokersExecutionClientConfig {
    pub host: String,
    pub port: u16,
    pub client_id: i32,
    pub account_id: Option<String>,
    pub base_currency: Option<Currency>,
    pub connection_timeout: u64,
    pub request_timeout: u64,
    pub fetch_all_open_orders: bool,
    pub track_option_exercise_from_position_update: bool,
    pub max_reconnect_attempts: Option<u32>,
    pub instrument_provider: InteractiveBrokersInstrumentProviderConfig,
}

Configuration for Interactive Brokers execution client.

Fields

host: String

Host for IB Gateway/TWS.

port: u16

Port for IB Gateway/TWS.

client_id: i32

Client ID.

account_id: Option<String>

Raw IB account code, such as DU123456. The Nautilus account ID becomes {client name}-{code}.

base_currency: Option<Currency>

Base currency for the account, normally the currency IB reports the account summary in. None keeps a multi-currency account with one balance per currency.

connection_timeout: u64

Connection timeout in seconds.

request_timeout: u64

Request timeout in seconds for IB API requests (open orders, executions, positions, etc.).

fetch_all_open_orders: bool

Whether to fetch all open orders (reqAllOpenOrders vs reqOpenOrders).

track_option_exercise_from_position_update: bool

Whether to track option exercise from position updates.

max_reconnect_attempts: Option<u32>

Bound on ibapi’s automatic reconnect attempts, see the field of the same name on InteractiveBrokersDataClientConfig. The shared-client registry connects once per (host, port, client_id), so when data and exec share a connection the first creator’s value wins.

instrument_provider: InteractiveBrokersInstrumentProviderConfig

Instrument provider configuration.

Implementations

impl InteractiveBrokersExecutionClientConfig

pub fn builder() -> InteractiveBrokersExecutionClientConfigBuilder

Create an instance of InteractiveBrokersExecutionClientConfig using the builder syntax

impl InteractiveBrokersExecutionClientConfig

pub fn validate(&self) -> ConfigResult<()>

Validates that configured selections contain no duplicates.

Errors

Returns an error if a selection repeats a value.

Trait Implementations

impl ClientConfig for InteractiveBrokersExecutionClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for InteractiveBrokersExecutionClientConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InteractiveBrokersExecutionClientConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for InteractiveBrokersExecutionClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for InteractiveBrokersExecutionClientConfig

impl<'de> Deserialize<'de> for InteractiveBrokersExecutionClientConfig

where InteractiveBrokersExecutionClientConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'py> FromPyObject<'a, 'py> for InteractiveBrokersExecutionClientConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for InteractiveBrokersExecutionClientConfig

type Target = InteractiveBrokersExecutionClientConfig

The Python output type

type Output = Bound<'py, InteractiveBrokersExecutionClientConfig>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject(self, py: Python<'py>) -> PyResult<Bound<'py, Self>>

Performs the conversion.

impl PyClass for InteractiveBrokersExecutionClientConfig

const NAME: &str = "InteractiveBrokersExecutionClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassBaseType for InteractiveBrokersExecutionClientConfig

type LayoutAsBase = <InteractiveBrokersExecutionClientConfig as PyClassImpl>::Layout

type BaseNativeType = <InteractiveBrokersExecutionClientConfig as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<InteractiveBrokersExecutionClientConfig>

type PyClassMutability = <InteractiveBrokersExecutionClientConfig as PyClassImpl>::PyClassMutability

type Layout<T: PyClassImpl> = <<InteractiveBrokersExecutionClientConfig as PyClassBaseType>::BaseNativeType as PyClassBaseType>::Layout<T>

The type of object layout to use for ancestors or descendants of this type.

impl PyClassImpl for InteractiveBrokersExecutionClientConfig

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = true

#[pyclass(subclass)]

const RAW_DOC: &'static CStr = /// Configuration for Interactive Brokers execution client.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<InteractiveBrokersExecutionClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<InteractiveBrokersExecutionClientConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForInteractiveBrokersExecutionClientConfig

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn __traverse__(&self, visit: PyVisit<'_>) -> Result<(), PyTraverseError>

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for InteractiveBrokersExecutionClientConfig

const TEXT_SIGNATURE: &'static str = "(host=None, port=None, client_id=None, account_id=None, connection_timeout=None, request_timeout=None, fetch_all_open_orders=None, track_option_exercise_from_position_update=None, instrument_provider=None, dockerized_gateway=None, base_currency=None, max_reconnect_attempts=None)"

impl PyStubType for InteractiveBrokersExecutionClientConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for InteractiveBrokersExecutionClientConfig

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for InteractiveBrokersExecutionClientConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.