Struct Key 

pub struct Key(/* private fields */);

Database key type

Keys are Arc-wrapped byte slices for cheap cloning and sharing. They implement Ord for use in sorted data structures (LSM-Tree).

Implementations

impl Key

pub const MAX_SIZE: usize

Maximum key size (64KB)

pub fn new(bytes: impl Into<Arc<[u8]>>) -> Key

Create a new key from bytes

pub fn from_slice(bytes: &[u8]) -> Key

Create from a byte slice

pub fn from_str(s: &str) -> Key

Create from a string

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

Get the key as a byte slice

pub fn len(&self) -> usize

Get the length of the key

pub fn is_empty(&self) -> bool

Check if the key is empty

pub fn to_string_lossy(&self) -> String

Convert to a string if valid UTF-8

pub fn as_arc(&self) -> &Arc<[u8]>

Get the Arc-wrapped bytes for zero-copy sharing

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

Clone into a Vec

Trait Implementations

impl AsRef<[u8]> for Key

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

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

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

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

Formats the value using the given formatter.

impl From<&[u8]> for Key

fn from(bytes: &[u8]) -> Key

Converts to this type from the input type.

impl From<&str> for Key

fn from(s: &str) -> Key

Converts to this type from the input type.

impl From<String> for Key

fn from(s: String) -> Key

Converts to this type from the input type.

impl From<Vec<u8>> for Key

fn from(bytes: Vec<u8>) -> Key

Converts to this type from the input type.

impl Hash for Key

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

where H: Hasher,

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 Ord for Key

fn cmp(&self, other: &Key) -> 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 PartialEq for Key

fn eq(&self, other: &Key) -> 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 PartialOrd for Key

fn partial_cmp(&self, other: &Key) -> 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 Eq for Key

impl StructuralPartialEq for Key