26493315423
95%

Ran 27 May 2026 05:52AM UTC

Jobs 1

Files 92

Run time 1min

Badge

Embed ▾

Committed 27 May 2026 05:46AM UTC coverage: 94.908%. Remained the same

Build # 26493315423

Build Type

push

github

Committed by

web-flow

Commit Message

docs(consensus): align README with current public surface (#568)

The README is ingested into the lib via `#![doc = include_str!(...)]`,
so it ships to docs.rs and crates.io as the first surface external
`ConsensusDriver` implementers read. Four facts on it had drifted from
the code:

- `LeaderState` variants were listed as `Leader / Follower / Candidate
  / NoLeader`; the actual enum at `src/leadership.rs:37-69` is
  `Leader { epoch }`, `Follower { leader_endpoint, leader_epoch }`,
  `Unknown`. Neither `Candidate` nor `NoLeader` exist.
- A `bt` feature flag was documented but does not exist in
  `Cargo.toml` (only `default` and `serde` are declared).
- `AdvancePayload` and `reject_out_of_range_advance` were absent from
  "What's in the box" though both are re-exported at `src/lib.rs:36`
  and consumed by every shipped driver.
- A new "Required pre-persist guard" H2 makes the MUST-call contract
  on `persist_high_water` explicit and frames the poison-write hazard
  from `advance.rs:69-91`: the high-water only ratchets, so an
  out-of-range commit is non-recoverable because every subsequent
  leader's load fails `PhysicalMs::try_new`.

Signed-off-by: Sebastian Thiebaud <sebastian@prismarisk.com>

Coverage Stats

14184 of 14945 relevant lines covered (94.91%)

402986.36 hits per line

Jobs

ID	Job ID	Ran	Files	Coverage
1	26493315423.1	27 May 2026 05:52AM UTC	92	94.91	GitHub Action Run

prisma-risk / tsoracle / 26493315423
95%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 26493315423

prisma-risk / tsoracle / 26493315423 95%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Jobs

Source Files on build 26493315423

prisma-risk / tsoracle / 26493315423
95%

README BADGES
x