Struct zerotrie::byte_phf::PerfectByteHashMap

#[repr(transparent)]
pub struct PerfectByteHashMap<Store: ?Sized>(Store);

A constant-time map from bytes to unique indices.

Uses a perfect hash function (see module-level documentation). Does not support mutation.

Standard layout: P, N bytes of Q, N bytes of expected keys

Tuple Fields

0: Store

Implementations

impl PerfectByteHashMap<Vec<u8>>

pub fn try_new(keys: &[u8]) -> Result<Self, Error>

Computes a new PerfectByteHashMap.

(this is a doc-hidden API)

impl<Store> PerfectByteHashMap<Store>

pub fn from_store(store: Store) -> Self

Creates an instance from a pre-existing store. See Self::as_bytes.

impl<Store> PerfectByteHashMap<Store>

where Store: AsRef<[u8]> + ?Sized,

pub fn get(&self, key: u8) -> Option<usize>

Gets the usize for the given byte, or None if it is not in the map.

pub fn num_items(&self) -> usize

This is called num_items because len is ambiguous: it could refer to the number of items or the number of bytes.

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

Get an iterator over the keys in the order in which they are stored in the map.

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

Returns the map as bytes. The map can be recovered with Self::from_store or Self::from_bytes.

impl PerfectByteHashMap<[u8]>

pub fn from_bytes(bytes: &[u8]) -> &Self

Creates an instance from pre-existing bytes. See Self::as_bytes.

impl<Store> PerfectByteHashMap<Store>

where Store: AsRef<[u8]> + ?Sized,

pub fn as_borrowed(&self) -> &PerfectByteHashMap<[u8]>

Converts from PerfectByteHashMap<AsRef<[u8]>> to &PerfectByteHashMap<[u8]>

Trait Implementations

impl<Store: Debug + ?Sized> Debug for PerfectByteHashMap<Store>

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

Formats the value using the given formatter.

impl<Store: PartialEq + ?Sized> PartialEq for PerfectByteHashMap<Store>

fn eq(&self, other: &PerfectByteHashMap<Store>) -> 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<Store: Eq + ?Sized> Eq for PerfectByteHashMap<Store>

impl<Store: ?Sized> StructuralPartialEq for PerfectByteHashMap<Store>