Struct BloomSegment 

pub struct BloomSegment { /* private fields */ }

Owning bloom header that can be embedded in a segment.

Implementations

impl BloomSegment

pub fn with_capacity(expected: usize) -> BloomSegment

Build a bloom sized for expected elements at a 1% false-positive rate. Cheap — allocates ~9.6 * expected / 8 bytes.

pub fn with_rate(expected: usize, fp_rate: f64) -> BloomSegment

Custom false-positive rate.

pub fn insert(&mut self, key: &[u8])

Record key as possibly present.

pub fn contains(&self, key: &[u8]) -> bool

Might key be present? (May return a false positive, never a false negative.)

pub fn definitely_absent(&self, key: &[u8]) -> bool

Inverse of contains — the thing callers usually want.

pub fn estimated_fp_rate(&self) -> f64

Estimated current false-positive rate given the number of insertions.

pub fn inserted_count(&self) -> u32

Number of elements recorded so far (best-effort).

pub fn filter(&self) -> &BloomFilter

Access the underlying bloom filter (e.g. to pass to crate::storage::index::IndexBase::bloom).

pub fn union_inplace(&mut self, other: &BloomSegment) -> bool

Merge another bloom segment into this one. Both must have the same size and hash count. Returns false on mismatch.

pub fn encode(&self) -> Vec<u8>

Serialise into the header layout documented at module level.

pub fn decode(bytes: &[u8]) -> Result<(BloomSegment, usize), BloomSegmentError>

Parse a previously encoded header. Returns a fresh BloomSegment and the number of bytes consumed.

Trait Implementations

impl Debug for BloomSegment

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

Formats the value using the given formatter.