Struct KeyDictionary 

pub struct KeyDictionary { /* private fields */ }

An append-only field-name↔id catalogue for one document collection.

Ids are dense, assigned 0, 1, 2, … in interning order, and never reused.

Implementations

impl KeyDictionary

pub fn new() -> Self

Create an empty dictionary.

pub fn len(&self) -> usize

Number of interned field names.

pub fn is_empty(&self) -> bool

Whether the dictionary holds no names.

pub fn intern(&mut self, name: &str) -> u32

Intern name, returning its (stable) id.

If name is already present its existing id is returned and nothing is appended; otherwise a new id is assigned at the end of the catalogue. This is the transactional append used by the write path when it classifies a key as common.

pub fn id_of(&self, name: &str) -> Option<u32>

Look up the id for an already-interned name, if any.

Unlike intern this never mutates the dictionary, so a caller can ask “is this key already common?” without appending.

pub fn name_of(&self, id: u32) -> Option<&str>

Resolve an id back to its field name, if the id is in range.

pub fn encode(&self, out: &mut Vec<u8>)

Serialize the dictionary into out for persistence in the collection catalogue.

Names are written in id order, so a decode reconstructs the exact same id assignment.

pub fn decode(data: &[u8]) -> Result<Self, KeyDictError>

Deserialize a dictionary previously produced by encode.

Trait Implementations

impl Clone for KeyDictionary

fn clone(&self) -> KeyDictionary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyDictionary

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

Formats the value using the given formatter.

impl Default for KeyDictionary

fn default() -> KeyDictionary

Returns the “default value” for a type.

impl PartialEq for KeyDictionary

fn eq(&self, other: &KeyDictionary) -> 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 StructuralPartialEq for KeyDictionary