Trait radix_trie::TrieKey

pub trait TrieKey: PartialEq + Eq {
    fn encode_bytes(&self) -> Vec<u8> { ... }
    fn encode(&self) -> Nibblet { ... }
}

Trait for types which can be used to key a Radix Trie.

Types that implement this trait should be convertible to a vector of half-bytes (nibbles) such that no two instances of the type convert to the same vector. To protect against faulty behaviour, the trie will panic if it finds two distinct keys of type K which encode to the same Nibblet, so be careful!

If you would like to implement this trait for your own type, you need to implement either encode_bytes or encode. You only need to implement one of the two. If you don't implement one, your code will panic as soon you use the trie. There is no performance penalty for implementing encode_bytes instead of encode, so it is preferred except in the case where you require half-byte precision.

Many standard types implement this trait already. Integer types are encoded big-endian by default but can be encoded little-endian using the LittleEndian<T> wrapper type.

Provided methods

fn encode_bytes(&self) -> Vec<u8>

Encode a value as a vector of bytes.

fn encode(&self) -> Nibblet

Encode a value as a NibbleVec.

Loading content...

Implementations on Foreign Types

impl TrieKey for Vec<u8>

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for [u8]

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for String

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for str

fn encode_bytes(&self) -> Vec<u8>

impl<'a, T: ?Sized + TrieKey> TrieKey for &'a T

fn encode_bytes(&self) -> Vec<u8>

impl<'a, T: ?Sized + TrieKey> TrieKey for &'a mut T

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for i8

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for u8

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for PathBuf

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for Path

fn encode_bytes(&self) -> Vec<u8>

impl<T> TrieKey for LittleEndian<T> where
    T: Eq + Copy, 

fn encode_bytes(&self) -> Vec<u8>

impl<T> TrieKey for BigEndian<T> where
    T: Eq + Copy, 

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for u16

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for u32

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for u64

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for i16

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for i32

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for i64

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for usize

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for isize

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for Vec<u16>

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for Vec<u32>

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for Vec<u64>

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for Vec<i16>

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for Vec<i32>

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for Vec<i64>

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for Vec<usize>

fn encode_bytes(&self) -> Vec<u8>

impl TrieKey for Vec<isize>

fn encode_bytes(&self) -> Vec<u8>

Loading content...

Implementors

Loading content...