Struct Prunable 

pub struct Prunable { /* private fields */ }

A Bitmap paired with a “pruned-below” watermark.

See the module-level documentation for semantics and granularity.

Implementations

impl Prunable

pub const fn new() -> Self

Creates an empty prunable bitmap with no pruning applied.

pub fn len(&self) -> u64

Returns the cardinality (number of values currently in the set).

Pruning subtracts from this: dropping a container with N values reduces len() by N. This differs from super::super::Prunable::len (the dense BitMap<N> wrapper), which preserves length across pruning because positions are meaningful in a sequential bit array. Here, only present values are counted.

pub fn is_empty(&self) -> bool

Returns whether the bitmap is empty.

pub const fn pruned_below(&self) -> u64

Returns the current pruning watermark.

Always a multiple of 65536. No value < pruned_below exists in the bitmap.

pub fn insert(&mut self, value: u64) -> bool

Inserts a value into the bitmap. Returns true if newly inserted.

Panics

Panics if value < pruned_below().

pub fn insert_range(&mut self, range: Range<u64>) -> u64

Inserts a range of values into the bitmap. Returns the number of values newly inserted.

Panics

Panics if start < pruned_below().

pub fn contains(&self, value: u64) -> bool

Checks if the bitmap contains the given value.

Panics

Panics if value < pruned_below().

pub fn prune(&mut self, threshold: u64) -> u64

Prunes all values strictly less than threshold, rounding down to the nearest container boundary (multiple of 65536).

Returns the threshold actually applied (the rounded-down value), which is also the new value of Self::pruned_below.

No-op if the rounded threshold is <= pruned_below().

pub fn min(&self) -> Option<u64>

Returns the minimum value in the bitmap, if any.

pub fn max(&self) -> Option<u64>

Returns the maximum value in the bitmap, if any.

pub fn iter(&self) -> impl Iterator<Item = u64> + '_

Returns an iterator over the values in sorted order.

pub fn iter_range(&self, range: Range<u64>) -> impl Iterator<Item = u64> + '_

Returns an iterator over the values in the range in sorted order.

Panics

Panics if start < pruned_below().

pub fn clear(&mut self)

Clears all values from the bitmap. Does not reset Self::pruned_below.

Trait Implementations

impl Clone for Prunable

fn clone(&self) -> Prunable

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Prunable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Prunable

fn default() -> Prunable

Returns the “default value” for a type.

impl EncodeSize for Prunable

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

fn encode_inline_size(&self) -> usize

Returns the encoded size excluding bytes passed to BufsMut::push during Write::write_bufs. Used to size the working buffer for inline writes. Override alongside Write::write_bufs for types where large Bytes fields go via push; failing to do so will over-allocate.

impl Extend<u64> for Prunable

fn extend<I: IntoIterator<Item = u64>>(&mut self, iter: I)

Inserts each value from the iterator. Panics if any value is below Self::pruned_below, matching Self::insert.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<u64> for Prunable

fn from_iter<I: IntoIterator<Item = u64>>(iter: I) -> Self

Creates a value from an iterator.

impl PartialEq for Prunable

fn eq(&self, other: &Prunable) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Read for Prunable

type Cfg = RangeCfg<usize>

Configuration for decoding: range limit on number of containers (passed through to the underlying Bitmap).

fn read_cfg(buf: &mut impl Buf, cfg: &Self::Cfg) -> Result<Self, CodecError>

Reads a value from the buffer using the provided configuration cfg.

impl Write for Prunable

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

fn write_bufs(&self, buf: &mut impl BufsMut)

Writes to a BufsMut, allowing existing Bytes chunks to be appended via BufsMut::push instead of written inline. Must encode to the same format as Write::write. Defaults to Write::write.

impl Eq for Prunable

impl StructuralPartialEq for Prunable