Struct BaseKey

pub struct BaseKey {
    pub bytes: Vec<u8>,
}

A wrapper over Vec<u8> with functions for using it as a key prefix.

Fields

bytes: Vec<u8>

The byte value of the key prefix.

Implementations

impl BaseKey

pub fn base_tag(&self, tag: u8) -> Vec<u8>

Concatenates the base key and tag.

pub fn base_tag_index(&self, tag: u8, index: &[u8]) -> Vec<u8>

Concatenates the base key, tag and index.

pub fn base_index(&self, index: &[u8]) -> Vec<u8>

Concatenates the base key and index.

pub fn derive_key<I: Serialize>(&self, index: &I) -> Result<Vec<u8>, Error>

Obtains the Vec<u8> key from the key by serialization and using the base key.

pub fn derive_tag_key<I: Serialize>( &self, tag: u8, index: &I, ) -> Result<Vec<u8>, Error>

Obtains the Vec<u8> key from the key by serialization and using the base_key.

pub fn derive_short_key<I: Serialize + ?Sized>( index: &I, ) -> Result<Vec<u8>, Error>

Obtains the short Vec<u8> key from the key by serialization.

pub fn deserialize_value<Item: DeserializeOwned>( bytes: &[u8], ) -> Result<Item, Error>

Deserialize bytes into type Item.

Trait Implementations

impl Clone for BaseKey

fn clone(&self) -> BaseKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BaseKey

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

Formats the value using the given formatter.

impl Default for BaseKey

fn default() -> BaseKey

Returns the “default value” for a type.

impl From<Vec<u8>> for BaseKey

fn from(value: Vec<u8>) -> Self

Converts to this type from the input type.