Struct KvPair

pub struct KvPair(pub Key, pub Value);

A key/value pair.

Examples

let key = "key".to_owned();
let value = "value".to_owned();
let constructed = KvPair::new(key.clone(), value.clone());
let from_tuple = KvPair::from((key, value));
assert_eq!(constructed, from_tuple);

Many functions which accept a KvPair accept an Into<KvPair>, which means all of the above types (Like a (Key, Value)) can be passed directly to those functions.

Tuple Fields

0: Key

1: Value

Implementations

impl KvPair

pub fn new(key: impl Into<Key>, value: impl Into<Value>) -> Self

Create a new KvPair.

pub fn key(&self) -> &Key

Immutably borrow the Key part of the KvPair.

pub fn value(&self) -> &Value

Immutably borrow the Value part of the KvPair.

pub fn into_key(self) -> Key

Consume self and return the Key part.

pub fn into_value(self) -> Value

Consume self and return the Value part.

pub fn key_mut(&mut self) -> &mut Key

Mutably borrow the Key part of the KvPair.

pub fn value_mut(&mut self) -> &mut Value

Mutably borrow the Value part of the KvPair.

pub fn set_key(&mut self, k: impl Into<Key>)

Set the Key part of the KvPair.

pub fn set_value(&mut self, v: impl Into<Value>)

Set the Value part of the KvPair.

Trait Implementations

impl AsRef<Key> for KvPair

fn as_ref(&self) -> &Key

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

impl AsRef<Vec<u8>> for KvPair

fn as_ref(&self) -> &Value

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

impl Clone for KvPair

fn clone(&self) -> KvPair

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KvPair

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

Formats the value using the given formatter.

impl Default for KvPair

fn default() -> KvPair

Returns the “default value” for a type.

impl<K, V> From<(K, V)> for KvPair

where K: Into<Key>, V: Into<Value>,

fn from((k, v): (K, V)) -> Self

Converts to this type from the input type.

impl From<KvPair> for (Key, Value)

fn from(pair: KvPair) -> Self

Converts to this type from the input type.

impl From<KvPair> for Key

fn from(pair: KvPair) -> Self

Converts to this type from the input type.

impl PartialEq for KvPair

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

impl StructuralPartialEq for KvPair