prisma-risk / tsoracle / 26371989549

95%

push

github

feat(openraft-toolkit): promote leadership stream by-value entry to stable API (#310)

`stream_from_receiver` carried `#[doc(hidden)]` and a "not part of the
public API and may change without notice" comment while being declared
`pub fn` in a `pub mod` — so it was on the API surface regardless, and
two crates depended on it (the openraft driver and the toolkit's own
integration tests). `doc(hidden)` only hides from rustdoc; it does not
remove the symbol from the public surface.

The by-value form is genuinely needed: the driver builds a `'static`
leadership stream from an owned `host.metrics()` receiver, which the
borrowed `leadership_events(&raft)` form cannot provide, and the
integration tests inject synthetic watch channels through it to exercise
the #77 full-value dedup logic without a live cluster. Hiding it would
break both unless the dedup logic were duplicated.

Promote it to a stable, documented public API:

- Rename `stream_from_receiver` -> `leadership_events_from_metrics` so it
  pairs explicitly with `leadership_events(&raft)`.
- Remove `#[doc(hidden)]` and the disclaimer; document the by-value /
  `'static` use case and the shared dedup contract; pin the signature.
- Re-export it at the crate root and `lifecycle::`, beside
  `leadership_events`.
- Update both consumers and the standalone example's README (which also
  misstated the dedup as role-class-only; corrected to full-value).

Closes #98

2 of 3 new or added lines in 2 files covered. (66.67%)

11267 of 11871 relevant lines covered (94.91%)

465547.5 hits per line