Struct block_id::BlockId

pub struct BlockId<T: Copy + Hash + Eq> { /* private fields */ }

Represents a specific, deterministic two-way mapping between u64 values and opaque IDs.

For BlockId<char>, additional functionality is provided for mapping between u64s and Strings.

Implementations

impl<T: Copy + Hash + Eq> BlockId<T>

pub fn new(alphabet: Alphabet<T>, seed: u128, min_length: u8) -> Self

Construct a block ID mapping. Mappings are deterministic based on the three parameters passed at construction: the alphabet, seed, and minimum length.

pub fn encode(&self, v: u64) -> Option<Vec<T>>

Encode a given u64 into an opaque Vec<T>.

pub fn decode(&self, v: Vec<T>) -> Option<u64>

Decode an opaque Vec<T> from a given u64.

impl BlockId<char>

For the special case of BlockId<char>, helper encoders/decoders that use strings rather than vectors are provided.

pub fn encode_string(&self, v: u64) -> Option<String>

Encode a u64 into an opaque string.

pub fn decode_string(&self, v: &str) -> Option<u64>

Decode a u64 from an opaque string.

Trait Implementations

impl<T: Clone + Copy + Hash + Eq> Clone for BlockId<T>

fn clone(&self) -> BlockId<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy + Hash + Eq> Debug for BlockId<T>

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

Formats the value using the given formatter.