Struct watto::StringTable

pub struct StringTable { /* private fields */ }

Available on crate feature strings only.

A struct for storing strings without duplicates.

Add strings to the table with insert. The returned usize can be used to read the string back from the table’s byte representation.

Use as_bytes to obtain a byte representation of a StringTable. The byte representation is the concatenation of the strings that have been added to the table, with each individual string prefixed with its length in LEB128 encoding. The byte representation contains each string only once.

Example

use watto::StringTable;
let mut table = StringTable::new();
let foo_idx = table.insert("foo");
let bar_idx = table.insert("bar");
let string_bytes = table.as_bytes();
assert_eq!(StringTable::read(string_bytes, foo_idx).unwrap(), "foo");
assert_eq!(StringTable::read(string_bytes, bar_idx).unwrap(), "bar");

Implementations

impl StringTable

pub fn new() -> Self

Initializes an empty StringTable.

pub fn insert(&mut self, s: &str) -> usize

Insert a string into this StringTable.

Returns an offset that can be used to retrieve the inserted string with read after serializing this table with as_bytes.

pub fn as_bytes(&self) -> &[u8]

Returns a byte slice containing the concatenation of the strings that have been added to this StringTable.

pub fn into_bytes(self) -> Vec<u8>

Returns a byte vector containing the concatenation of the strings that have been added to this StringTable.

This consumes the StringTable.

pub fn read(string_bytes: &[u8], offset: usize) -> Result<&str, ReadStringError>

Returns the string stored at the given offset in the byte slice, if any.

Use this to retrieve a string that was previously inserted into a StringTable.

Trait Implementations

impl Clone for StringTable

fn clone(&self) -> StringTable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StringTable

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

Formats the value using the given formatter.

impl Default for StringTable

fn default() -> StringTable

Returns the “default value” for a type.