Struct SuffixBag 

pub struct SuffixBag { /* private fields */ }

Contiguous storage for key suffixes.

Implementations

impl SuffixBag

pub fn compact_with_permuter<P: PermutationProvider>( &mut self, perm: &P, exclude_slot: Option<usize>, ) -> usize

Compact using a permutation to determine active slots.

Returns

The number of bytes reclaimed.

impl SuffixBag

pub fn new() -> Self

Create a new suffix bag with initial capacity.

pub fn with_capacity(capacity: usize) -> Self

Create a new suffix bag with specified capacity.

pub fn from_vec(data: Vec<u8>) -> Self

Construct SuffixBag by reusing an existing Vec<u8> buffer.

pub const fn capacity(&self) -> usize

Return the current capacity of the data buffer.

pub const fn used(&self) -> usize

Return the number of bytes currently used.

pub const fn count(&self) -> usize

Return the number of slots that have suffixes.

pub fn reserve(&mut self, additional: usize)

Reserve additional capacity for suffix data.

pub fn try_assign(&mut self, slot: usize, suffix: &[u8]) -> bool

Assign a suffix with smart space management.

Panics

Panics if suffix.len() > u16::MAX (65535 bytes).

pub fn has_suffix(&self, slot: usize) -> bool

Check if a slot has a suffix.

Panics

Panics if slot >= 15.

pub fn get(&self, slot: usize) -> Option<&[u8]>

Get the suffix for a slot, or None if no suffix.

Panics

Panics if slot >= 15.

pub fn get_or_empty(&self, slot: usize) -> &[u8]

Get the suffix for a slot, or empty slice if no suffix.

Panics

Panics if slot >= 15.

pub fn try_assign_append_only(&mut self, slot: usize, suffix: &[u8]) -> bool

Append-only suffix assignment for concurrent use.

Unlike try_assign_in_place, this method never overwrites existing suffix bytes. New data is always appended to the end of the buffer, so concurrent OCC readers reading old offsets see stable data. Old suffix space becomes dead until drain-and-rebuild.

Panics

Panics if slot >= 15 or if suffix length exceeds u16::MAX.

pub fn try_assign_in_place(&mut self, slot: usize, suffix: &[u8]) -> bool

Try to assign a suffix to a slot in-place, without growing the buffer.

This method may overwrite existing suffix bytes in-place when the new suffix fits. It is NOT safe for concurrent use (readers may observe partially-written data). Use try_assign_append_only for the concurrent path.

Panics

Panics if slot >= 15 or if suffix length exceeds u16::MAX.

pub fn assign(&mut self, slot: usize, suffix: &[u8])

Assign a suffix to a slot.

Panics

Panics if slot >= 15 or if suffix length exceeds u16::MAX.

pub fn clear(&mut self, slot: usize)

Clear the suffix for a slot.

Panics

Panics if slot >= 15.

pub fn suffix_equals(&self, slot: usize, suffix: &[u8]) -> bool

Check if a slot’s suffix equals the given suffix.

pub fn suffix_compare(&self, slot: usize, suffix: &[u8]) -> Option<Ordering>

Compare a slot’s suffix with the given suffix.

Trait Implementations

impl Clone for SuffixBag

fn clone(&self) -> Self

Clone with compaction, only copies active suffix data.

This avoids copying dead/garbage data from the original buffer.

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

Performs copy-assignment from source.

impl Debug for SuffixBag

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

Formats the value using the given formatter.

impl Default for SuffixBag

fn default() -> Self

Returns the “default value” for a type.