ibapi 5.1.0

An unofficial Rust client for the Interactive Brokers TWS API. Async (Tokio) and blocking clients for TWS and IB Gateway.
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

//! Folds account summary batches into snapshots, shared by the sync and async clients.

use super::super::{AccountSummaryResult, AccountSummarySnapshot};
use crate::subscriptions::StreamDecoder;

/// Accumulates batches into a snapshot and decides when one is complete.
#[derive(Debug, Default)]
pub(in crate::accounts) struct SnapshotBuilder {
    snapshot: AccountSummarySnapshot,
    pending: bool,
    emitted: bool,
}

impl SnapshotBuilder {
    /// Applies one batch from [`next_batch`](crate::subscriptions::Subscription::next_batch).
    /// Returns a snapshot when it completes one: the first at the batch that ends in `End`, even
    /// when empty, so a slow initial dump split by the quiet period is held until its `End`; each
    /// later one at any batch that changed a value.
    pub(in crate::accounts) fn fold(&mut self, batch: Vec<AccountSummaryResult>) -> Option<AccountSummarySnapshot> {
        let ended = batch.last().is_some_and(StreamDecoder::is_batch_end);
        for result in batch {
            if let AccountSummaryResult::Summary(summary) = result {
                self.pending |= self.snapshot.apply(summary);
            }
        }

        let complete = if self.emitted { self.pending } else { ended };
        complete.then(|| self.take())
    }

    /// Returns the rows not yet emitted, for when the subscription ends.
    pub(in crate::accounts) fn flush(&mut self) -> Option<AccountSummarySnapshot> {
        self.pending.then(|| self.take())
    }

    fn take(&mut self) -> AccountSummarySnapshot {
        self.pending = false;
        self.emitted = true;
        self.snapshot.clone()
    }
}

#[cfg(test)]
#[path = "snapshots_tests.rs"]
mod tests;