wboayue / rust-ibapi / 25478878073

92%

push

github

feat(market_data)!: realtime_bars builder; align sync/async

* feat(market_data)!: realtime_bars builder; align sync/async (#486)

Replace the divergent flat realtime_bars signatures with a fluent builder.

- Sync was 4 args, missing options. Async was 5 args with non-idiomatic
  &BarSize / &WhatToShow refs (both Copy). Aligning flat hits 5 params,
  violating CLAUDE.md rule 9.
- New: client.realtime_bars(&contract).{what_to_show,trading_hours,options}
  ().subscribe(). Defaults Trades + Regular + no options. Identical surface
  on sync vs async; only the terminal .subscribe() is .awaited on async.
- BarSize dropped from public surface (TWS only accepts 5-second bars; can
  return non-breakingly via .bar_size if IB ever expands).
- options is now reachable from sync, fixing the v2 asymmetry.

Tests: 6 new unit tests (4 sync + 2 async) covering defaults / overrides /
options round-trip; existing test_realtime_bars on both sides routed
through the builder. The test-side RealtimeBarsRequestBuilder gained
.options() so encoding asserts cover the sync-options gap.

Migrated callers: 8 examples, 2 integration tests, 1 doctest in
client/sync.rs. Docs: README (10 sites), migration-3.0.md (new section 7),
quick-start.md, api-patterns.md.

* refactor(realtime): tighten builder follow-ups

- RealtimeBarsBuilder::new -> pub(crate); only legitimate caller is
  Client::realtime_bars entry method.
- Async builder_tests gain stubbed_client() helper, mirroring sync side.

* refactor(realtime): simplify pass on builder PR

- Use shared create_blocking_test_client / create_test_client from
  common::test_utils::helpers instead of inline stubbed_client() helpers.
- Drop redundant .request_id(TEST_REQ_ID_FIRST) calls — already the
  default on RealtimeBarsRequestBuilder.
- Drop "Called by RealtimeBarsBuilder::subscribe" caller-narration on
  pub(crate) helpers (CLAUDE.md "no caller references").
- Fix README indentation regression in 3 multi-thread/retry examples
  introd... (continued)

54 of 54 new or added lines in 4 files covered. (100.0%)

17629 of 20002 relevant lines covered (88.14%)

26.84 hits per line