26139819001
92%

Ran 20 May 2026 03:43AM UTC

Jobs 1

Files 128

Run time 1min

Badge

Embed ▾

Committed 20 May 2026 03:41AM UTC coverage: 92.141%. Remained the same

Build # 26139819001

Build Type

push

github

Committed by

web-flow

Commit Message

docs(client): document canonical Client paths; hide non-canonical impl modules (#596)

Resolves v3-api-ergonomics.md §3 'Async-vs-blocking naming asymmetry' by
documenting the convention rather than restructuring the source tree.

- Add '## Canonical paths' section to src/client/mod.rs rustdoc spelling
  out that `ibapi::Client` is the canonical async path and
  `ibapi::client::blocking::Client` is the canonical sync-explicit path
  (the spelling already used by README, MIGRATION.md, integration tests).
- `#[doc(hidden)]` on `pub mod sync` and `pub mod r#async` so docs.rs
  surfaces only the two canonical paths in the navigation tree. Modules
  remain `pub` so existing callers reaching through `client::sync::*` or
  `client::r#async::*` keep compiling — no source-breaking change.
- Fix two outlier doc-examples
  (src/market_data/realtime/builder.rs, src/market_data/builder/market_data_builder.rs)
  that imported `ibapi::client::r#async::Client`; switch to
  `ibapi::prelude::*` (which re-exports the canonical `Client`).

Rejected option (b) — exposing `client::r#async` as a sibling for symmetry
would force raw-identifier syntax (`use ibapi::client::r#async::Client;`)
in user code, which is uglier than the root `Client` re-export.

Coverage Stats

18994 of 20614 relevant lines covered (92.14%)

27.42 hits per line

Jobs

ID	Job ID	Ran	Files	Coverage
1	26139819001.1	20 May 2026 03:43AM UTC	128	92.14	GitHub Action Run

wboayue / rust-ibapi / 26139819001
92%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 26139819001

wboayue / rust-ibapi / 26139819001 92%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 26139819001

wboayue / rust-ibapi / 26139819001
92%

README BADGES
x