Struct FullKey

pub struct FullKey<T: AsRef<[u8]>> {
    pub user_key: UserKey<T>,
    pub epoch_with_gap: EpochWithGap,
}

FullKey is an internal concept in storage. It associates UserKey with an epoch.

The encoded format is | user_key | epoch |.

Fields

user_key: UserKey<T>

epoch_with_gap: EpochWithGap

Implementations

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

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

pub fn new_with_gap_epoch( table_id: TableId, table_key: TableKey<T>, epoch_with_gap: EpochWithGap, ) -> Self

pub fn from_user_key(user_key: UserKey<T>, epoch: HummockEpoch) -> Self

pub fn for_test(table_id: TableId, table_key: T, epoch: HummockEpoch) -> 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(&self) -> Vec<u8>

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

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

pub fn is_empty(&self) -> bool

pub fn encoded_len(&self) -> usize

Get the length of the encoded format.

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

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

Construct a FullKey from a byte slice.

pub fn from_slice_without_table_id( table_id: TableId, slice_without_table_id: &'a [u8], ) -> Self

Construct a FullKey from a byte slice without table_id encoded.

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

Construct a FullKey from a byte slice.

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

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

impl FullKey<Vec<u8>>

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

Calling this method may accidentally cause memory allocation when converting Vec into Bytes

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

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

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

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

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

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

Trait Implementations

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

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

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

Formats the value using the given formatter.

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

fn default() -> FullKey<T>

Returns the “default value” for a type.

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

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

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

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

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

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