Struct StringTableBuilder 

pub struct StringTableBuilder<O = u32, I = u16, const NULL_PADDED: bool = false, A: Allocator + Clone = Global>
where
    O: Offset,
    I: StringIndex,
{ /* private fields */ }

Incremental builder for crate::StringTable.

Each call to Self::try_push appends string bytes to a single byte buffer and appends one offset.

Generic parameters control capacity and metadata size:

• O is the byte-offset type (see Offset). It bounds total UTF-8 bytes and costs size_of::<O>() per string inside the crate::StringTable.
• I is the string-ID type (see StringIndex) used by crate::StringId. It limits string count and costs size_of::<I>() per stored ID field (table index) in your own structs.

The common choice is O = u32, I = u16: meaning 4 GiB of UTF-8 data and 64Ki entries per table.

This is 4 bytes per string offset in the table and 2 bytes per StringID (index into table) inside your structs. For comparison: Box<str> == 16 bytes, String == 24 bytes.

By default, inserted strings are not NUL-terminated. Set NULL_PADDED = true to store strings with a trailing NUL byte.

Implementations

impl StringTableBuilder<u32, u16, false, Global>

pub fn new() -> Self

Creates an empty builder using the global allocator.

pub fn with_capacity(strings: usize, bytes: usize) -> Self

Creates a builder with reserved capacities using the global allocator.

strings is the expected number of strings, bytes is the expected total number of UTF-8 bytes.

impl StringTableBuilder<u32, u16, true, Global>

pub fn new_null_padded() -> Self

Creates an empty builder with null-padded mode using the global allocator.

pub fn with_capacity_null_padded(strings: usize, bytes: usize) -> Self

Creates a null-padded builder with reserved capacities using the global allocator.

strings is the expected number of strings, bytes is the expected total number of UTF-8 bytes.

impl<O: Offset, I: StringIndex, const NULL_PADDED: bool, A: Allocator + Clone> StringTableBuilder<O, I, NULL_PADDED, A>

pub fn new_in(allocator: A) -> Self

Creates an empty builder with a custom allocator.

pub fn with_capacity_in(strings: usize, bytes: usize, allocator: A) -> Self

Creates a builder with reserved capacities and a custom allocator.

strings is the expected number of strings, bytes is the expected total number of UTF-8 bytes.

pub fn len(&self) -> usize

Number of strings currently pushed.

pub fn is_empty(&self) -> bool

Returns true when the builder has no strings.

pub fn bytes_len(&self) -> usize

Current total byte length of pushed string data.

pub fn try_push(&mut self, value: &str) -> Result<StringId<I>>

Appends a string and returns its StringId.

Returns an error when total string count exceeds the configured ID type, or when the byte length cannot be represented by the configured offset type.

pub fn build(self) -> StringTable<O, I, NULL_PADDED, A>

Finalizes into an immutable crate::StringTable.

This does not copy string bytes. Internal vectors are converted into boxed slices so the resulting table is immutable and compact.

Trait Implementations

impl Default for StringTableBuilder<u32, u16, false, Global>

fn default() -> Self

Returns the “default value” for a type.