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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

use super::*;
use crate::testdata::builders::config::config_response;
use crate::testdata::builders::ResponseProtoEncoder;

#[test]
fn test_decode_config_proto_populated() {
    let bytes = config_response()
        .read_only_api(true)
        .socket_port(4002)
        .trusted_ip("127.0.0.1")
        .bypass_bond_warning(true)
        .seek_price_improvement(true)
        .auto_logoff_time("23:59")
        .message(1, "Order Warning", false)
        .encode_proto();

    let config = decode_config_proto(&bytes).unwrap();

    let api = config.api.expect("api present");
    let settings = api.settings.expect("settings present");
    assert_eq!(settings.read_only_api, Some(true));
    assert_eq!(settings.socket_port, Some(4002));
    assert_eq!(settings.trusted_ips, vec!["127.0.0.1".to_string()]);
    assert_eq!(api.precautions.expect("precautions present").bypass_bond_warning, Some(true));

    let orders = config.orders.expect("orders present");
    assert_eq!(orders.smart_routing.expect("smart routing present").seek_price_improvement, Some(true));

    assert_eq!(
        config.lock_and_exit.expect("lock_and_exit present").auto_logoff_time,
        Some("23:59".to_string())
    );

    assert_eq!(config.messages.len(), 1);
    assert_eq!(config.messages[0].id, Some(1));
    assert_eq!(config.messages[0].title, Some("Order Warning".to_string()));
    assert_eq!(config.messages[0].enabled, Some(false));
}

#[test]
fn test_decode_config_proto_empty() {
    let bytes = proto::ConfigResponse::default().encode_to_vec();

    let config = decode_config_proto(&bytes).unwrap();

    assert_eq!(config, Config::default());
    assert!(config.api.is_none());
    assert!(config.orders.is_none());
    assert!(config.lock_and_exit.is_none());
    assert!(config.messages.is_empty());
}

#[test]
fn test_decode_config_message_dispatches_config_response() {
    let bytes = config_response().read_only_api(false).encode_proto();
    let message = crate::common::test_utils::helpers::proto_response(IncomingMessages::ConfigResponse, bytes);

    let config = decode_config_message(&message).unwrap();
    assert_eq!(config.api.unwrap().settings.unwrap().read_only_api, Some(false));
}

#[test]
fn test_decode_config_message_routes_error() {
    // IncomingMessages::Error == 4; a text-framed error surfaces as an Err.
    let message = ResponseMessage::from("4\09000\0322\0error text\0");
    assert!(decode_config_message(&message).is_err());
}

#[test]
fn test_decode_config_message_rejects_unexpected_type() {
    // WshMetaData (104) is not claimed by the config decoder.
    let message = ResponseMessage::from("104\09000\0{}\0");
    match decode_config_message(&message) {
        Err(Error::UnexpectedResponse(_)) => {}
        other => panic!("expected UnexpectedResponse, got {other:?}"),
    }
}

#[test]
fn test_decode_config_rejects_text_framing() {
    // A ConfigResponse that arrives text-framed (no proto payload) must surface
    // UnexpectedResponse via require_proto().
    let message = ResponseMessage::from("110\09000\0\0");
    match decode_config_message(&message) {
        Err(Error::UnexpectedResponse(_)) => {}
        other => panic!("expected UnexpectedResponse, got {other:?}"),
    }
}

#[test]
fn test_decode_update_config_message_populated() {
    let bytes = crate::testdata::builders::config::update_config_response()
        .status("warning")
        .message("please confirm")
        .changed_field("socketPort")
        .error("bad value")
        .warning(131, "Confirm Mandatory Cap Price")
        .encode_proto();
    let message = crate::common::test_utils::helpers::proto_response(IncomingMessages::UpdateConfigResponse, bytes);

    let response = decode_update_config_message(&message).unwrap();
    assert_eq!(response.status.as_deref(), Some("warning"));
    assert_eq!(response.message.as_deref(), Some("please confirm"));
    assert_eq!(response.changed_fields, vec!["socketPort".to_string()]);
    assert_eq!(response.errors, vec!["bad value".to_string()]);
    assert_eq!(response.warnings.len(), 1);
    assert_eq!(response.warnings[0].message_id, Some(131));
    assert_eq!(response.warnings[0].title.as_deref(), Some("Confirm Mandatory Cap Price"));
}

#[test]
fn test_decode_update_config_message_routes_error() {
    let message = ResponseMessage::from("4\09000\0322\0error text\0");
    assert!(decode_update_config_message(&message).is_err());
}

#[test]
fn test_decode_update_config_message_rejects_unexpected_type() {
    let message = ResponseMessage::from("104\09000\0{}\0");
    match decode_update_config_message(&message) {
        Err(Error::UnexpectedResponse(_)) => {}
        other => panic!("expected UnexpectedResponse, got {other:?}"),
    }
}

#[test]
fn test_decode_update_config_rejects_text_framing() {
    let message = ResponseMessage::from("111\09000\0\0");
    match decode_update_config_message(&message) {
        Err(Error::UnexpectedResponse(_)) => {}
        other => panic!("expected UnexpectedResponse, got {other:?}"),
    }
}