ibapi 2.11.2

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

//! Encoders for display group messages.

use crate::messages::{OutgoingMessages, RequestMessage};
use crate::Error;

const VERSION: i32 = 1;

/// Encodes a request to subscribe to display group events.
pub(crate) fn encode_subscribe_to_group_events(request_id: i32, group_id: i32) -> Result<RequestMessage, Error> {
    let mut message = RequestMessage::new();
    message.push_field(&OutgoingMessages::SubscribeToGroupEvents);
    message.push_field(&VERSION);
    message.push_field(&request_id);
    message.push_field(&group_id);
    Ok(message)
}

/// Encodes a request to unsubscribe from display group events.
pub(crate) fn encode_unsubscribe_from_group_events(request_id: i32) -> Result<RequestMessage, Error> {
    let mut message = RequestMessage::new();
    message.push_field(&OutgoingMessages::UnsubscribeFromGroupEvents);
    message.push_field(&VERSION);
    message.push_field(&request_id);
    Ok(message)
}

/// Encodes a request to update the contract displayed in a display group.
///
/// # Arguments
/// * `request_id` - The request ID (should match the subscription request ID)
/// * `contract_info` - Contract to display, format: "contractID@exchange" (e.g., "265598@SMART"),
///   "none" for empty selection, or "combo" for combination contracts
pub(crate) fn encode_update_display_group(request_id: i32, contract_info: &str) -> Result<RequestMessage, Error> {
    let mut message = RequestMessage::new();
    message.push_field(&OutgoingMessages::UpdateDisplayGroup);
    message.push_field(&VERSION);
    message.push_field(&request_id);
    message.push_field(&contract_info);
    Ok(message)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ToField;

    #[test]
    fn test_encode_subscribe_to_group_events() {
        let request_id = 9000;
        let group_id = 1;

        let message = encode_subscribe_to_group_events(request_id, group_id).expect("encoding failed");

        assert_eq!(message[0], OutgoingMessages::SubscribeToGroupEvents.to_field());
        assert_eq!(message[1], "1"); // version
        assert_eq!(message[2], request_id.to_field());
        assert_eq!(message[3], group_id.to_field());
    }

    #[test]
    fn test_encode_unsubscribe_from_group_events() {
        let request_id = 9000;

        let message = encode_unsubscribe_from_group_events(request_id).expect("encoding failed");

        assert_eq!(message[0], OutgoingMessages::UnsubscribeFromGroupEvents.to_field());
        assert_eq!(message[1], "1"); // version
        assert_eq!(message[2], request_id.to_field());
    }

    #[test]
    fn test_encode_update_display_group() {
        let request_id = 9000;
        let contract_info = "265598@SMART";

        let message = encode_update_display_group(request_id, contract_info).expect("encoding failed");

        assert_eq!(message[0], OutgoingMessages::UpdateDisplayGroup.to_field());
        assert_eq!(message[1], "1"); // version
        assert_eq!(message[2], request_id.to_field());
        assert_eq!(message[3], contract_info);
    }

    #[test]
    fn test_encode_update_display_group_none() {
        let request_id = 9000;
        let contract_info = "none";

        let message = encode_update_display_group(request_id, contract_info).expect("encoding failed");

        assert_eq!(message[0], OutgoingMessages::UpdateDisplayGroup.to_field());
        assert_eq!(message[3], "none");
    }
}