wboayue / rust-ibapi / 25406495849
92%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 124
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 87.873%. Remained the same
25406495849

push

github

web-flow 
docs: notification handling + v3.0 migration guide (PR 6) (#514)

* docs: notification handling + v3.0 migration guide (PR 6)

New "Handling notifications" section in README covers per-subscription
Notice items, filter-vs-observe pattern, and handshake-time callbacks
(startup_notice_callback over notice_stream for the farm-status burst).

New docs/migration-3.0.md covers the three breaking changes:
SubscriptionItem<T> wrapping, removed error()/clear_error(), and the
new globally routed notice stream. Before/after for market_data,
place_order, account_summary.

Doc-comment audit on Subscription methods: each one names the Notice
arm and cross-links the data-only vs full-iterator alternative.
Client::notice_stream cross-links Subscription::next and points to
startup_notice_callback for handshake-time observability.

Also fixes the broken subscription.error() reference in the README's
Fault Tolerance example and migrates existing realtime-bars examples
to iter_data().flatten() / next_data() so they print bare bars.

* docs(pr6): address review — fix doc-link, drop silent-error flatten, drop unused import

- Fix mismatched intra-doc link in `Subscription::try_next`: display text
  said `try_next_data` (which doesn't exist); now correctly points to
  `try_iter_data`.
- Replace `iter_data().flatten()` patterns in the migration guide and the
  realtime async README sample with explicit `match`-on-`Result` so
  terminal errors aren't silently dropped. The mechanical-migration
  callout now warns about this.
- Drop unused `futures::StreamExt` imports in two README async samples
  (subscription methods used are inherent, not from `StreamExt`).

* docs(pr6): fix rustdoc broken intra-doc links

Running `RUSTDOCFLAGS="-D warnings" cargo doc` surfaced 4 broken links —
all of them in or adjacent to the files touched by this PR:

- `Client::notice_stream` (sync + async): bare `[`NoticeStream`]` had no
  resolution path; now `[`NoticeStream`](crate::subscriptions::Not... (continued)

17268 of 19651 relevant lines covered (87.87%)

26.95 hits per line

Jobs
ID Job ID Ran Files Coverage
1 25406495849.1 124
87.87
 GitHub Action Run
Source Files on build 25406495849