Struct TableKey

pub struct TableKey<T: AsRef<[u8]>>(pub T);

TableKey is an internal concept in storage. It’s a wrapper around the key directly from the user, to make the code clearer and avoid confusion with encoded UserKey and FullKey.

Its name come from the assumption that Hummock is always accessed by a table-like structure identified by a TableId.

Tuple Fields

0: T

Implementations

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

pub fn split_vnode(&self) -> (VirtualNode, &[u8])

pub fn vnode_part(&self) -> VirtualNode

pub fn key_part(&self) -> &[u8]

pub fn to_ref(&self) -> TableKey<&[u8]>

impl TableKey<&[u8]>

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

Trait Implementations

impl<T: AsRef<[u8]>> AsRef<[u8]> for TableKey<T>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: AsRef<[u8]>> Borrow<[u8]> for TableKey<T>

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

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

fn clone(&self) -> TableKey<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 TableKey<T>

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

Formats the value using the given formatter.

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

fn default() -> TableKey<T>

Returns the “default value” for a type.

impl<T: AsRef<[u8]>> Deref for TableKey<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: AsRef<[u8]>> DerefMut for TableKey<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl EstimateSize for TableKey<Bytes>

fn estimated_heap_size(&self) -> usize

The estimated heap size of the current struct in bytes.

fn estimated_size(&self) -> usize

where Self: Sized,

The estimated total size of the current struct in bytes, including the estimated_heap_size and the size of Self.

impl<T: Hash + AsRef<[u8]>> Hash for TableKey<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 TableKey<T>

fn cmp(&self, other: &TableKey<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 TableKey<T>

fn eq(&self, other: &TableKey<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 TableKey<T>

fn partial_cmp(&self, other: &TableKey<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 TableKey<T>

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

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