Struct Key 

pub struct Key { /* private fields */ }

A key identifying a Value.

Implementations

impl Key

pub const fn from_static(b: &'static [u8]) -> Key

Create a new Key from static bytes without copying.

pub const fn from_static_str(b: &'static str) -> Key

Create a new Key from a &'static str without copying.

pub fn as_str(&self) -> Option<&str>

Read the key as a str slice if it can be parsed as a UTF8 string.

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

Read the key as a byte slice.

pub fn inner(&self) -> &Bytes

Read the inner Bytes struct.

pub fn as_str_lossy(&self) -> Cow<'_, str>

Read the key as a lossy UTF8 string with String::from_utf8_lossy.

pub fn into_string(self) -> Option<String>

Convert the key to a UTF8 string, if possible.

pub fn into_bytes(self) -> Bytes

Read the inner bytes making up the key.

pub fn as_bytes_str(&self) -> Option<StrInner<Bytes>>

Parse and return the key as a Str without copying the inner contents.

pub fn cluster_hash(&self) -> u16

Hash the key to find the associated cluster hash slot.

pub fn cluster_owner<C>(&self, client: &C) -> Option<Server>

where C: ClientLike,

Read the host:port of the cluster node that owns the key if the client is clustered and the cluster state is known.

pub fn take(&mut self) -> Bytes

Replace this key with an empty byte array, returning the bytes from the original key.

pub fn convert<K>(self) -> Result<K, Error>

where K: FromKey,

Attempt to convert the key to any type that implements FromKey.

See the Value::convert documentation for more information.

Trait Implementations

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<'a> From<&'a [u8]> for Key

fn from(b: &'a [u8]) -> Key

Converts to this type from the input type.

impl From<&Key> for Key

fn from(k: &Key) -> Key

Converts to this type from the input type.

impl From<&StrInner<Bytes>> for Key

fn from(s: &StrInner<Bytes>) -> 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<&str> for Key

fn from(s: &str) -> Key

Converts to this type from the input type.

impl From<Box<[u8]>> for Key

fn from(b: Box<[u8]>) -> Key

Converts to this type from the input type.

impl From<Bytes> for Key

fn from(b: Bytes) -> Key

Converts to this type from the input type.

impl From<StrInner<Bytes>> for Key

fn from(s: StrInner<Bytes>) -> 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<bool> for Key

fn from(b: bool) -> Key

Converts to this type from the input type.

impl From<f32> for Key

fn from(val: f32) -> Key

Converts to this type from the input type.

impl From<f64> for Key

fn from(val: f64) -> Key

Converts to this type from the input type.

impl From<i128> for Key

fn from(val: i128) -> Key

Converts to this type from the input type.

impl From<i16> for Key

fn from(val: i16) -> Key

Converts to this type from the input type.

impl From<i32> for Key

fn from(val: i32) -> Key

Converts to this type from the input type.

impl From<i64> for Key

fn from(val: i64) -> Key

Converts to this type from the input type.

impl From<i8> for Key

fn from(val: i8) -> Key

Converts to this type from the input type.

impl From<isize> for Key

fn from(val: isize) -> Key

Converts to this type from the input type.

impl From<u128> for Key

fn from(val: u128) -> Key

Converts to this type from the input type.

impl From<u16> for Key

fn from(val: u16) -> Key

Converts to this type from the input type.

impl From<u32> for Key

fn from(val: u32) -> Key

Converts to this type from the input type.

impl From<u64> for Key

fn from(val: u64) -> Key

Converts to this type from the input type.

impl From<u8> for Key

fn from(val: u8) -> Key

Converts to this type from the input type.

impl From<usize> for Key

fn from(val: usize) -> Key

Converts to this type from the input type.

impl FromKey for Key

fn from_key(value: Key) -> Result<Key, Error>

impl FromValue for Key

fn from_value(value: Value) -> Result<Key, Error>

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 TryFrom<Value> for Key

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Key, <Key as TryFrom<Value>>::Error>

Performs the conversion.

impl Eq for Key

impl StructuralPartialEq for Key