wboayue / rust-ibapi / 25323281489

92%

Build Type

push

github

Committed by web-flow

Commit Message

feat(subscriptions): widen Subscription<T> public API to SubscriptionItem<T> (closes #487) (#504)

* feat(subscriptions): widen Subscription<T> public API to SubscriptionItem<T>

Public API change (closes #487):

  Sync  next/try_next/next_timeout: Option<T>          -> Option<Result<SubscriptionItem<T>, Error>>
  Async next                       : Option<Result<T, Error>> -> Option<Result<SubscriptionItem<T>, Error>>

* New public type `SubscriptionItem<T> = Data(T) | Notice(Notice)`
  exposed at `ibapi::subscriptions::SubscriptionItem`.
* Sync drops `error()` accessor and the internal `Mutex<Option<Error>>`
  field; errors flow via the `Err` arm of every yielding method.
* New iterator adapters `iter_data` / `try_iter_data` / `timeout_iter_data`
  on sync and `next_data` on both sync + async filter notices and yield
  `Result<T, Error>` for callers that only care about data.
* Existing `iter` / `try_iter` / `timeout_iter` widen to yield
  `Result<SubscriptionItem<T>, Error>`; `IntoIterator` impls match.

Notice arm is structurally present but unreachable until PR 3 emits notices
from the dispatcher.

* refactor(consumers): migrate to SubscriptionItem-aware API

Consumer-side sweep for the widened `Subscription<T>` API:

* Library tests, integration tests, examples, and doc tests now use
  `next_data()` / `iter_data()` (filtering notices to keep legacy-shape
  return) where they previously expected `T` directly.
* Dropped all `subscription.error()` callers — errors flow via `Err` arm
  of `next_data()` / `iter_data()` items.
* Restructured `examples/sync/stream_retry.rs` retry loop with a labeled
  loop so `Err(Error::ConnectionReset)` from the iterator can `continue`
  the outer retry.
* Restructured `examples/sync/bracket_order.rs` to use
  `subscription.try_iter_data().next()` for mutable counter access.
* Doc tests on `accounts`, `client`, `historical`, `realtime`, `news`,
  `orders`, `scanner` rewritten to demonstrate the new shape.

* chore: dr... (continued)

Coverage Stats

48 of 79 new or added lines in 6 files covered. (60.76%)

4 existing lines in 1 file now uncovered.

16978 of 19397 relevant lines covered (87.53%)

26.25 hits per line