ibapi 3.3.0

A Rust implementation of the Interactive Brokers TWS API, providing a reliable and user friendly interface for TWS and IB Gateway. Designed with a focus on simplicity and performance.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

//! Fluent builder for `update_config` write requests.

use crate::config::common::encoders;
use crate::config::{ApiConfig, ConfigWarning, LockAndExit, MessageSetting, OrdersConfig};
use crate::proto;

/// Fluent builder for editing TWS/Gateway configuration.
///
/// Set only the groups you want to change; unset groups are left untouched by
/// the gateway. Terminate with [`submit`](Self::submit). Obtain one from
/// [`Client::update_config`](crate::Client::update_config).
#[must_use = "UpdateConfigBuilder does nothing until you call .submit()"]
pub struct UpdateConfigBuilder<'a, C> {
    pub(in crate::config::builder) client: &'a C,
    lock_and_exit: Option<LockAndExit>,
    messages: Vec<MessageSetting>,
    api: Option<ApiConfig>,
    orders: Option<OrdersConfig>,
    accepted_warnings: Vec<ConfigWarning>,
    reset_api_order_sequence: bool,
}

impl<'a, C> UpdateConfigBuilder<'a, C> {
    pub(in crate::config) fn new(client: &'a C) -> Self {
        Self {
            client,
            lock_and_exit: None,
            messages: Vec::new(),
            api: None,
            orders: None,
            accepted_warnings: Vec::new(),
            reset_api_order_sequence: false,
        }
    }

    /// Edit the API-level configuration (precautions and/or settings).
    pub fn api(mut self, api: ApiConfig) -> Self {
        self.api = Some(api);
        self
    }

    /// Edit the order-handling configuration.
    pub fn orders(mut self, orders: OrdersConfig) -> Self {
        self.orders = Some(orders);
        self
    }

    /// Edit the lock-and-exit (auto-logoff) settings.
    pub fn lock_and_exit(mut self, lock_and_exit: LockAndExit) -> Self {
        self.lock_and_exit = Some(lock_and_exit);
        self
    }

    /// Add a message-prompt edit. Call repeatedly to edit multiple prompts.
    pub fn message(mut self, message: MessageSetting) -> Self {
        self.messages.push(message);
        self
    }

    /// Add several message-prompt edits at once (appends). Convenient for
    /// replaying a [`Config::messages`](crate::config::Config::messages) snapshot.
    pub fn messages(mut self, messages: impl IntoIterator<Item = MessageSetting>) -> Self {
        self.messages.extend(messages);
        self
    }

    /// Acknowledge a warning from a prior [`UpdateConfigResponse`](crate::config::UpdateConfigResponse)
    /// so the gateway applies the edit on re-submission. Call once per warning.
    pub fn accept_warning(mut self, warning: ConfigWarning) -> Self {
        self.accepted_warnings.push(warning);
        self
    }

    /// Acknowledge several warnings at once (appends). Convenient for echoing a
    /// prior [`UpdateConfigResponse::warnings`](crate::config::UpdateConfigResponse)
    /// in one call before re-submitting.
    pub fn accept_warnings(mut self, warnings: impl IntoIterator<Item = ConfigWarning>) -> Self {
        self.accepted_warnings.extend(warnings);
        self
    }

    /// Request that the gateway reset the API order-id sequence.
    pub fn reset_api_order_sequence(mut self) -> Self {
        self.reset_api_order_sequence = true;
        self
    }

    /// Assemble the wire request from the accumulated edits.
    pub(in crate::config) fn to_proto(&self, request_id: i32) -> proto::UpdateConfigRequest {
        proto::UpdateConfigRequest {
            req_id: Some(request_id),
            lock_and_exit: self.lock_and_exit.as_ref().map(encoders::to_proto_lock_and_exit),
            messages: self.messages.iter().map(encoders::to_proto_message).collect(),
            api: self.api.as_ref().map(encoders::to_proto_api),
            orders: self.orders.as_ref().map(encoders::to_proto_orders),
            accepted_warnings: self.accepted_warnings.iter().map(encoders::to_proto_warning).collect(),
            reset_api_order_sequence: self.reset_api_order_sequence.then_some(true),
        }
    }
}