Struct OffsetIndex

pub struct OffsetIndex {
    pub name: String,
    pub offsets: IndexMap<Box<str>, u64>,
    pub init: bool,
}

An ordered mapping from entity ID to byte offset into the source file it resides in.

A wrapper around indexmap::IndexMap.

Fields

name: String

The name of the index. There may potentially be more than one index per file

offsets: IndexMap<Box<str>, u64>

The mapping from ID to byte offset, ordered by occurrence

init: bool

Whether the index has been initalized explicitly or not, as it may be initially empty or read as empty.

Implementations

impl OffsetIndex

pub fn new(name: String) -> OffsetIndex

pub fn get(&self, key: &str) -> Option<u64>

Get the offset of the specified key

pub fn get_index(&self, index: usize) -> Option<(&str, u64)>

Get the associated key and offset for the specified index position

pub fn index_of(&self, key: &str) -> Option<usize>

Get the position in the index for a specific key

pub fn insert<T>(&mut self, key: T, offset: u64) -> Option<u64>

where T: Into<Box<str>>,

Insert key into the index with an offset value

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn keys(&self) -> Keys<'_, Box<str>, u64>

pub fn iter(&self) -> Iter<'_, Box<str>, u64>

Iterate over the keys and indices

pub fn contains_key(&self, key: &str) -> bool

Check if the key is in the index

Trait Implementations

impl Clone for OffsetIndex

fn clone(&self) -> OffsetIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OffsetIndex

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

Formats the value using the given formatter.

impl Default for OffsetIndex

fn default() -> OffsetIndex

Returns the “default value” for a type.