Struct ArenaStr 

pub struct ArenaStr { /* private fields */ }

Interning arena for strings.

Implementations

impl ArenaStr

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

Creates a new arena with pre-allocated space to store at least the given number of strings, totalling the given number of bytes.

pub fn strings(&self) -> usize

Returns the number of strings in this arena.

Note that because ArenaStr is a concurrent data structure, this is only a snapshot as viewed by this thread, and the result may change if other threads are inserting values.

pub fn bytes(&self) -> usize

Returns the total number of bytes in this arena.

Note that because ArenaStr is a concurrent data structure, this is only a snapshot as viewed by this thread, and the result may change if other threads are inserting values.

pub fn is_empty(&self) -> bool

Checks if this arena is empty.

Note that because ArenaStr is a concurrent data structure, this is only a snapshot as viewed by this thread, and the result may change if other threads are inserting values.

pub fn find(&self, value: &str) -> Option<InternedStr>

Returns the given string’s InternedStr handle if it is already interned.

Otherwise, this simply returns None without adding the string to this arena.

pub fn push_mut(&mut self, value: &str) -> u32

Unconditionally push a value, without validating that it’s already interned.

impl ArenaStr

pub fn print_summary(&self, prefix: &str, title: &str, total_bytes: usize)

Available on crate feature debug only.

Prints a summary of the storage used by this arena to stdout.

impl ArenaStr

pub fn intern(&self, value: &str) -> InternedStr

Interns the given value in this arena.

If the value was already interned in this arena, its interning index will simply be returned. Otherwise it will be stored into the arena.

pub fn lookup(&self, interned: InternedStr) -> &str

Retrieves the given InternedStr value from this arena.

The caller is responsible for ensuring that the same arena was used to intern this value, otherwise an arbitrary value will be returned or a panic will happen.

If you only need to access the bytes, lookup_bytes() may be more efficient.

pub fn lookup_bytes(&self, interned: InternedStr) -> &[u8]

Retrieves the bytes for the given InternedStr value from this arena.

The caller is responsible for ensuring that the same arena was used to intern this value, otherwise an arbitrary value will be returned or a panic will happen.

Trait Implementations

impl Clone for ArenaStr

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArenaStr

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

Formats the value using the given formatter.

impl Default for ArenaStr

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ArenaStr

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GetSize for ArenaStr

Available on crate feature get-size2 only.

fn get_heap_size_with_tracker<Tr: GetSizeTracker>( &self, tracker: Tr, ) -> (usize, Tr)

Determines how many bytes this object occupies inside the heap while using a tracker.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines the total size of the object while using a tracker.

impl PartialEq for ArenaStr

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ArenaStr

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ArenaStr