Struct stable_bloom_filter::buckets::Buckets

pub struct Buckets { /* fields omitted */ }

Buckets is a fast, space-efficient array of buckets where each bucket can store up to a configured maximum value.

Methods

impl Buckets

pub fn new(count: usize, bucket_size: u8) -> Self

Creates a new Buckets with the provided number of buckets where each bucket is the specified number of bits.

pub fn max_bucket_value(&self) -> u8

Returns the maximum value that can be stored in a bucket.

pub fn count(&self) -> usize

Returns the number of buckets.

pub fn decrease(&mut self, bucket: usize, delta: u8) -> &Self

Decrease the value in the specified bucket by the provided delta. The value is clamped to zero and the maximum bucket value. Returns itself to allow for chaining.

pub fn increment(&mut self, bucket: usize, delta: u8) -> &Self

Increment the value in the specified bucket by the provided delta. The value is clamped to zero and the maximum bucket value. Returns itself to allow for chaining.

pub fn set(&mut self, bucket: usize, value: u8) -> &Self

Set the bucket value. The value is clamped to zero and the maximum bucket value. Returns itself to allow for chaining.

pub fn get(&self, bucket: usize) -> u8

Returns the value in the specified bucket.

pub fn reset(&mut self) -> &Self

Reset restores the Buckets to the original state. Returns itself to allow for chaining.