Struct DockerizedIBGateway 

pub struct DockerizedIBGateway { /* private fields */ }

Dockerized IB Gateway manager.

This struct manages the lifecycle of Interactive Brokers Gateway Docker containers, including creation, starting, stopping, and status checking.

Implementations

impl DockerizedIBGateway

pub const CONTAINER_NAME: &'static str = "nautilus-ib-gateway"

Base container name.

pub const HOST_PORTS: &'static [(&'static str, u16)]

Host API ports by trading mode.

pub const CONTAINER_PORTS: &'static [(&'static str, u16)]

Container API ports exposed by the IB Gateway image.

pub const VNC_PORT_INTERNAL: u16 = 5900

Internal VNC port.

pub fn new(config: DockerizedIBGatewayConfig) -> Result<Self>

Create a new DockerizedIBGateway from configuration.

Arguments

• config - Configuration for the gateway

Errors

Returns an error if:

• Username or password is not provided and not available in environment variables
• Docker client creation fails

pub fn container_name(&self) -> &str

Get the container name.

pub fn host(&self) -> &str

Get the host address.

pub fn port(&self) -> u16

Get the port.

pub async fn is_logged_in(&self, container_id: &str) -> Result<bool>

Check if the container is logged in by examining logs.

Arguments

• container_id - The container ID to check

Errors

Returns an error if log retrieval fails.

pub async fn container_status(&self) -> Result<ContainerStatus>

Get the current container status.

Errors

Returns an error if container inspection fails.

pub async fn start(&mut self, wait: Option<u64>) -> Result<()>

Start the gateway container.

Arguments

• wait - Optional wait time in seconds (overrides config timeout)

Errors

Returns an error if container creation or startup fails.

pub async fn safe_start(&mut self, wait: Option<u64>) -> Result<()>

Safely start the gateway, handling container already exists errors.

Arguments

• wait - Optional wait time in seconds

Errors

Returns an error if startup fails (other than container exists).

pub async fn stop(&self) -> Result<()>

Stop and remove the gateway container.

Errors

Returns an error if container stop or removal fails.

Trait Implementations

impl Clone for DockerizedIBGateway

fn clone(&self) -> DockerizedIBGateway

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DockerizedIBGateway

Available on crate feature gateway only.

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

Formats the value using the given formatter.

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

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 DockerizedIBGateway

type Target = DockerizedIBGateway

The Python output type

type Output = Bound<'py, <DockerizedIBGateway as IntoPyObject<'py>>::Target>

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>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for DockerizedIBGateway

const NAME: &str = "DockerizedIBGateway"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DockerizedIBGateway

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

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)]

const RAW_DOC: &'static CStr = /// Dockerized IB Gateway manager. /// /// This struct manages the lifecycle of Interactive Brokers Gateway Docker containers, /// including creation, starting, stopping, and status checking.

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 = <<DockerizedIBGateway as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<DockerizedIBGateway>

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

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 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 DockerizedIBGateway

const TEXT_SIGNATURE: &'static str = "(config)"

impl PyTypeInfo for DockerizedIBGateway

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

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 DerefToPyAny for DockerizedIBGateway