Enum b3_rs::ItemKey

pub enum ItemKey {
    NoKey,
    IntegerKey(u64),
    StringKey(String),
    BytesKey(Vec<u8>),
}

An item key.

Variants

NoKey

No key is set for this item.

IntegerKey(u64)

The key is a UVarInt (unsigned LEB128).

StringKey(String)

The key is a UTF-8 encoded string.

The key is encoded as the length of the UTF-8 string in bytes as a UVarInt (unsigned LEB128), and then the bytes of the string.

BytesKey(Vec<u8>)

The key is a byte array.

The key is encoded as the length of the byte array as a UVarInt (unsigned LEB128), and then the bytes.

Implementations

impl ItemKey

pub fn type_bits(&self) -> u8

Return the bits that would be set in the item control byte for the key type.

pub fn encode(&self) -> Result<Vec<u8>, Error>

Encode the key into it's byte representation.

pub fn decode(base: u8, ext: &[u8]) -> Result<(Self, usize), Error>

Trait Implementations

impl Clone for ItemKey

fn clone(&self) -> ItemKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ItemKey

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

Formats the value using the given formatter.

impl<'_> From<&'_ [u8]> for ItemKey

fn from(v: &[u8]) -> ItemKey

Performs the conversion.

impl<'_> From<&'_ str> for ItemKey

fn from(s: &str) -> ItemKey

Performs the conversion.

impl From<String> for ItemKey

fn from(s: String) -> ItemKey

Performs the conversion.

impl From<Vec<u8>> for ItemKey

fn from(v: Vec<u8>) -> ItemKey

Performs the conversion.

impl From<u64> for ItemKey

fn from(i: u64) -> ItemKey

Performs the conversion.

impl PartialEq<ItemKey> for ItemKey

fn eq(&self, other: &ItemKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ItemKey) -> bool

This method tests for !=.

impl StructuralPartialEq for ItemKey