Struct UserKey

pub struct UserKey<T: AsRef<[u8]>> {
    pub table_id: TableId,
    pub table_key: TableKey<T>,
}

UserKey is is an internal concept in storage. In the storage interface, user specifies table_key and table_id (in ReadOptions or WriteOptions) as the input. The storage will group these two values into one struct for convenient filtering.

The encoded format is | table_id | table_key |.

Fields

table_id: TableId

table_key: TableKey<T>

Implementations

impl<T: AsRef<[u8]>> UserKey<T>

pub fn new(table_id: TableId, table_key: TableKey<T>) -> Self

pub fn for_test(table_id: TableId, table_key: T) -> Self

Pass the inner type of table_key to make the code less verbose.

pub fn encode_into(&self, buf: &mut impl BufMut)

Encode in to a buffer.

pub fn encode_table_key_into(&self, buf: &mut impl BufMut)

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

pub fn is_empty(&self) -> bool

pub fn encoded_len(&self) -> usize

Get the length of the encoded format.

pub fn get_vnode_id(&self) -> usize

impl<'a> UserKey<&'a [u8]>

pub fn decode(slice: &'a [u8]) -> Self

Construct a UserKey from a byte slice. Its table_key will be a part of the input slice.

pub fn to_vec(self) -> UserKey<Vec<u8>>

pub fn copy_into<T: CopyFromSlice + AsRef<[u8]>>(self) -> UserKey<T>

impl<T: AsRef<[u8]> + Clone> UserKey<&T>

pub fn cloned(self) -> UserKey<T>

impl<T: AsRef<[u8]>> UserKey<T>

pub fn as_ref(&self) -> UserKey<&[u8]>

impl<T: AsRef<[u8]>> UserKey<T>

pub fn set<F>(&mut self, other: UserKey<F>)

where T: SetSlice<F>, F: AsRef<[u8]>,

Use this method to override an old UserKey<Vec<u8>> with a UserKey<&[u8]> to own the table key without reallocating a new UserKey object.

impl UserKey<Vec<u8>>

pub fn into_bytes(self) -> UserKey<Bytes>

Trait Implementations

impl<T: Clone + AsRef<[u8]>> Clone for UserKey<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: AsRef<[u8]>> Debug for UserKey<T>

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

Formats the value using the given formatter.

impl<T: Default + AsRef<[u8]>> Default for UserKey<T>

fn default() -> UserKey<T>

Returns the “default value” for a type.

impl<T: Hash + AsRef<[u8]>> Hash for UserKey<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord + AsRef<[u8]>> Ord for UserKey<T>

fn cmp(&self, other: &UserKey<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + AsRef<[u8]>> PartialEq for UserKey<T>

fn eq(&self, other: &UserKey<T>) -> 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<T: PartialOrd + AsRef<[u8]>> PartialOrd for UserKey<T>

fn partial_cmp(&self, other: &UserKey<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Copy + AsRef<[u8]>> Copy for UserKey<T>

impl<T: Eq + AsRef<[u8]>> Eq for UserKey<T>

impl<T: AsRef<[u8]>> StructuralPartialEq for UserKey<T>