Struct kvstructs::KeyRef

#[repr(transparent)]
pub struct KeyRef<'a> { /* private fields */ }

KeyRef can only contains a underlying u8 slice of Key

Implementations

impl<'a> KeyRef<'a>

pub const fn new(data: &'a [u8]) -> Self

Returns a KeyRef from byte slice

pub unsafe fn from_raw_key_pointer(rp: RawKeyPointer) -> Self

Returns a KeyRef from RawKeyPointer

Safety

The inner raw pointer of RawKeyPointer must be valid.

pub unsafe fn from_raw_pointer(ptr: *const u8, len: usize) -> Self

Returns a KeyRef from raw pointer and length

Safety

The raw pointer must be valid.

pub fn to_key(&self) -> Key

Copy KeyRef to a new Key.

pub fn len(&self) -> usize

Returns the number of bytes contained in this Key.

pub fn is_empty(&self) -> bool

Returns true if the Key has a length of 0.

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

Returns the underlying bytes

Trait Implementations

impl<'a> Clone for KeyRef<'a>

fn clone(&self) -> KeyRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for KeyRef<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8]> for KeyRef<'a>

fn from(data: &'a [u8]) -> Self

Converts to this type from the input type.

impl<'a> From<KeyRef<'a>> for RawKeyPointer

fn from(k: KeyRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for KeyRef<'a>

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, 

Feeds a slice of this type into the given Hasher.

impl KeyExt for &KeyRef<'_>

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

Returns the underlying slice of key (with timestamp data).

fn as_ptr(&self) -> *const u8

Returns raw pointer of the underlying byte slice

fn as_key_ref(&self) -> KeyRef<'_>

Returns a KeyRef.

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

Parses the actual key from the key bytes.

fn parse_timestamp(&self) -> u64

Parses the timestamp from the key bytes.

fn same_key(&self, other: impl KeyExt) -> bool

Checks for key equality ignoring the version timestamp.

fn compare_key(&self, other: impl KeyExt) -> Ordering

Checks the key without timestamp and checks the timestamp if keyNoTs is same. a would be sorted higher than aa if we use bytes.compare All keys should have timestamp.

fn has_prefix(&self, prefix: impl KeyExt) -> bool

Returns whether the slice self begins with prefix.

fn has_suffix(&self, suffix: impl KeyExt) -> bool

Returns whether the slice self ends with suffix.

fn longest_prefix(&self, other: impl KeyExt) -> &[u8]

Finds the longest shared prefix

fn longest_suffix(&self, other: impl KeyExt) -> &[u8]

Finds the longest shared suffix

fn longest_prefix_lossy(&self, other: impl KeyExt) -> Cow<'_, [u8]>

Finds the longest shared prefix, return a Cow<’_, u8>.

fn longest_suffix_lossy(&self, other: impl KeyExt) -> Cow<'_, [u8]>

Finds the longest shared suffix, return a Cow<’_, u8>.

impl KeyExt for &mut KeyRef<'_>

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

Returns the underlying slice of key (with timestamp data).

fn as_ptr(&self) -> *const u8

Returns raw pointer of the underlying byte slice

fn as_key_ref(&self) -> KeyRef<'_>

Returns a KeyRef.

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

Parses the actual key from the key bytes.

fn parse_timestamp(&self) -> u64

Parses the timestamp from the key bytes.

fn same_key(&self, other: impl KeyExt) -> bool

Checks for key equality ignoring the version timestamp.

fn compare_key(&self, other: impl KeyExt) -> Ordering

Checks the key without timestamp and checks the timestamp if keyNoTs is same. a would be sorted higher than aa if we use bytes.compare All keys should have timestamp.

fn has_prefix(&self, prefix: impl KeyExt) -> bool

Returns whether the slice self begins with prefix.

fn has_suffix(&self, suffix: impl KeyExt) -> bool

Returns whether the slice self ends with suffix.

fn longest_prefix(&self, other: impl KeyExt) -> &[u8]

Finds the longest shared prefix

fn longest_suffix(&self, other: impl KeyExt) -> &[u8]

Finds the longest shared suffix

fn longest_prefix_lossy(&self, other: impl KeyExt) -> Cow<'_, [u8]>

Finds the longest shared prefix, return a Cow<’_, u8>.

fn longest_suffix_lossy(&self, other: impl KeyExt) -> Cow<'_, [u8]>

Finds the longest shared suffix, return a Cow<’_, u8>.

impl KeyExt for KeyRef<'_>

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

Returns the underlying slice of key (with timestamp data).

fn as_ptr(&self) -> *const u8

Returns raw pointer of the underlying byte slice

fn as_key_ref(&self) -> KeyRef<'_>

Returns a KeyRef.

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

Parses the actual key from the key bytes.

fn parse_timestamp(&self) -> u64

Parses the timestamp from the key bytes.

fn same_key(&self, other: impl KeyExt) -> bool

Checks for key equality ignoring the version timestamp.

fn compare_key(&self, other: impl KeyExt) -> Ordering

Checks the key without timestamp and checks the timestamp if keyNoTs is same. a would be sorted higher than aa if we use bytes.compare All keys should have timestamp.

fn has_prefix(&self, prefix: impl KeyExt) -> bool

Returns whether the slice self begins with prefix.

fn has_suffix(&self, suffix: impl KeyExt) -> bool

Returns whether the slice self ends with suffix.

fn longest_prefix(&self, other: impl KeyExt) -> &[u8]

Finds the longest shared prefix

fn longest_suffix(&self, other: impl KeyExt) -> &[u8]

Finds the longest shared suffix

fn longest_prefix_lossy(&self, other: impl KeyExt) -> Cow<'_, [u8]>

Finds the longest shared prefix, return a Cow<’_, u8>.

fn longest_suffix_lossy(&self, other: impl KeyExt) -> Cow<'_, [u8]>

Finds the longest shared suffix, return a Cow<’_, u8>.

impl<'a> Ord for KeyRef<'a>

fn cmp(&self, other: &Self) -> Ordering

Checks the key without timestamp and checks the timestamp if keyNoTs is same. a would be sorted higher than aa if we use bytes.compare All keys should have timestamp.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<'a, K: KeyExt> PartialEq<K> for KeyRef<'a>

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

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

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

This method tests for !=.

impl<'a> PartialEq<KeyRef<'a>> for Bytes

fn eq(&self, other: &KeyRef<'a>) -> bool

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

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

This method tests for !=.

impl<'a> PartialEq<KeyRef<'a>> for BytesMut

fn eq(&self, other: &KeyRef<'a>) -> bool

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

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

This method tests for !=.

impl<'a> PartialEq<KeyRef<'a>> for Box<[u8]>

fn eq(&self, other: &KeyRef<'a>) -> bool

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

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

This method tests for !=.

impl<'a> PartialEq<KeyRef<'a>> for KeyMut

fn eq(&self, other: &KeyRef<'a>) -> bool

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

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

This method tests for !=.

impl<'a> PartialEq<KeyRef<'a>> for [u8]

fn eq(&self, other: &KeyRef<'a>) -> bool

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

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

This method tests for !=.

impl<'a> PartialEq<KeyRef<'a>> for Vec<u8>

fn eq(&self, other: &KeyRef<'a>) -> bool

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

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

This method tests for !=.

impl<'a> PartialEq<KeyRef<'a>> for str

fn eq(&self, other: &KeyRef<'a>) -> bool

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

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

This method tests for !=.

impl<'a> PartialEq<KeyRef<'a>> for String

fn eq(&self, other: &KeyRef<'a>) -> bool

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

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

This method tests for !=.

impl<'a, K: KeyExt> PartialOrd<K> for KeyRef<'a>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> PartialOrd<KeyRef<'a>> for Bytes

fn partial_cmp(&self, other: &KeyRef<'a>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> PartialOrd<KeyRef<'a>> for BytesMut

fn partial_cmp(&self, other: &KeyRef<'a>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> PartialOrd<KeyRef<'a>> for Box<[u8]>

fn partial_cmp(&self, other: &KeyRef<'a>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> PartialOrd<KeyRef<'a>> for KeyMut

fn partial_cmp(&self, other: &KeyRef<'a>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> PartialOrd<KeyRef<'a>> for [u8]

fn partial_cmp(&self, other: &KeyRef<'a>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> PartialOrd<KeyRef<'a>> for Vec<u8>

fn partial_cmp(&self, other: &KeyRef<'a>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> PartialOrd<KeyRef<'a>> for str

fn partial_cmp(&self, other: &KeyRef<'a>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> PartialOrd<KeyRef<'a>> for String

fn partial_cmp(&self, other: &KeyRef<'a>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> Copy for KeyRef<'a>

impl<'a> Eq for KeyRef<'a>