Skip to main content

ByteStringPool

Struct ByteStringPool 

Source
pub struct ByteStringPool { /* private fields */ }
Expand description

Append-only byte arena. Each interned byte sequence gets a stable ByteStrView handle whose (offset, len) survives all subsequent insertions (the underlying Vec<u8> may reallocate, but the indices into it are stable).

Pool capacity:

  • bytes: up to 4 GiB total raw payload (u32 offsets).
  • offsets: up to 2³² distinct entries.
  • lens: up to 2³² individual byte length (per-entry cap is also 2³²).

These limits are documented but not actively enforced beyond a try_push API: in v3 use the pool well below those numbers; if a future workload approaches the cap, promote to a u64-offset variant.

Implementations§

Source§

impl ByteStringPool

Source

pub fn new() -> Self

Create an empty pool.

Source

pub fn len(&self) -> usize

Number of entries currently in the pool.

Source

pub fn is_empty(&self) -> bool

True if the pool has no entries.

Source

pub fn byte_size(&self) -> usize

Total bytes stored (sum of all entry lengths). O(1).

Source

pub fn push(&mut self, bytes: &[u8]) -> Result<ByteStrView, ByteDictError>

Append a byte sequence and return a stable view.

Returns Err if the per-entry length exceeds u32::MAX or the total byte payload would exceed u32::MAX. These limits are wide enough that real-world pipelines never hit them, but we surface them as errors rather than panic for safety at boundaries.

Source

pub fn get(&self, view: ByteStrView) -> &[u8]

Resolve a view back to its byte slice. Panics in debug builds if the view points outside the pool; in release builds returns an empty slice for an out-of-bounds view (defensive — should never happen if views are only constructed by push).

Source

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

Resolve a view by entry index (position in insertion order).

Returns None if idx >= self.len().

Source

pub fn iter(&self) -> impl Iterator<Item = (usize, &[u8])> + '_

Iterate (index, bytes) in insertion order. Deterministic.

Source

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

Iterate views in insertion order. Use when you want to keep the (offset, len) representation (e.g. to thread it through a dictionary lookup).

Trait Implementations§

Source§

impl Clone for ByteStringPool

Source§

fn clone(&self) -> ByteStringPool

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ByteStringPool

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ByteStringPool

Source§

fn default() -> ByteStringPool

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ByteStringPool

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for ByteStringPool

Source§

impl StructuralPartialEq for ByteStringPool

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.