wboayue / rust-ibapi / 25397008708

92%

Build Type

push

github

Committed by web-flow

Commit Message

feat(subscriptions): global NoticeStream for unrouted IB notices (PR 5) (#512)

* feat(subscriptions): global NoticeStream for unrouted IB notices (PR 5)

Adds Client::notice_stream() so consumers can react programmatically to
notices arriving with no request_id (connectivity 1100/1101/1102, farm
status 2104-2108, etc.) instead of scraping logs.

- new dedicated NoticeStream type (sync + async); avoids the
  SubscriptionItem<Notice>::Notice semantic oddity
- sync NoticeBroadcaster (Mutex<Vec<crossbeam Sender>>, lazy prune on
  broadcast, close on shutdown); async uses broadcast::Sender directly
  since the tokio broadcast channel already provides subscribe/auto-prune
- two-line addition at each existing log_unrouted_notice call site;
  log + broadcast kept as separate concerns
- examples/sync/notice_stream.rs + examples/async/notice_stream.rs;
  prelude exports NoticeStream
- 6 sync + 5 async dispatcher e2e tests + 5+5 unit tests; live-gateway
  smoke test in integration/{sync,async}/tests/notice_delivery.rs

Tests: sync 936 lib + async 938 lib + all-features 1147 lib + 74 doc.
Clippy clean across default, sync-only, --all-features. Integration
crates (sync + async) compile + clippy clean.

* docs(claude): add rules 17-18 — dual-feature type pattern, skip parity wrappers

Distilled from PR 5 review. Rule 17 captures the Subscription / NoticeStream
dual-export shape (per-feature submodules, async-preferred top alias, sync
also at client::blocking::*). Rule 18 says don't wrap tokio broadcast/mpsc
just for sync/async parity when the runtime primitive already auto-prunes.

* docs(todos): add v3 public-API ergonomics tracking doc

Living checklist of pre-3.0 public-API rough edges (builders, newtypes,
order construction, error variants, etc.). Companion to the existing
topic-specific docs in todos/.

Coverage Stats

63 of 77 new or added lines in 6 files covered. (81.82%)

1 existing line in 1 file now uncovered.

17184 of 19546 relevant lines covered (87.92%)

26.68 hits per line