vigna / dsi-bitstream-rs / 29740807880

65%

Build Type

push

github

Committed by zommiommy

Commit Message

fix(reader): align the peek_bits contract and assertions with PEEK_BITS

The BitRead::peek_bits doc said n may be as large as PeekWord::BITS, and
both BufBitReader implementations debug_assert!-ed that same loose bound,
but PEEK_BITS is one word and peek_bits performs at most one refill: for a
u32-word reader with an empty buffer, a documented peek_bits(64) loads only
32 bits (failing the availability assertion in debug builds and returning
an invalid partial value in release builds). The guarantee is PEEK_BITS,
so the trait doc, the stale BufBitReader doc paragraph (which still
advertised word size plus one), and the entry assertions now all say
PEEK_BITS.

Tests cover both sides of the boundary: peek_bits(PEEK_BITS) from a
completely empty buffer must be served by a single refill for u16/u32/u64
words and both endiannesses, and peek_bits(PEEK_BITS + 1) panics in debug
builds.

Coverage Stats

2 of 2 new or added lines in 1 file covered. (100.0%)

300 existing lines in 9 files now uncovered.

2570 of 3980 relevant lines covered (64.57%)

2512407.34 hits per line