Struct KeyValue

pub struct KeyValue<K = String, V = f64> {
    pub key: K,
    pub value: V,
}

The KeyValue type is used to generically represent a simple key-value pair within a store.

Fields

key: K

value: V

Implementations

impl<K, V> KeyValue<K, V>

pub const fn new(key: K, value: V) -> Self

pub fn from_key(key: K) -> Self

where V: Default,

returns a new KeyValue from the given key, using the logical default for the value

pub fn from_value(value: V) -> Self

where K: Default,

returns a new KeyValue from the given value, using the logical default for the key

pub const fn key(&self) -> &K

returns an immutable reference to the key

pub const fn key_mut(&mut self) -> &mut K

returns a mutable reference to the key

pub const fn value(&self) -> &V

returns an immutable reference to the value

pub const fn value_mut(&mut self) -> &mut V

returns a mutable reference to the value

pub fn set_key(&mut self, key: K) -> &mut Self

update the current key and return a mutable reference to self

pub fn set_value(&mut self, value: V) -> &mut Self

update the current value and return a mutable reference to self

pub fn with_key<K2>(self, key: K2) -> KeyValue<K2, V>

consumes the current instance to create another with the given key

pub fn with_value<V2>(self, value: V2) -> KeyValue<K, V2>

consumes the current instance to create another with the given value

pub const fn replace_value(&mut self, value: V) -> V

replace the current value and return the old value

pub const fn swap_value(&mut self, other: &mut KeyValue<K, V>)

swap the current value with another in the given instance

pub fn take_value(&mut self) -> V

where V: Default,

take the current value and return it, replacing it with the logical default

pub fn entry(&mut self) -> KeyValue<&K, &mut V>

returns a new instance of the KeyValue with mutable references to the value and a reference to the key

pub const fn view(&self) -> KeyValue<&K, &V>

returns a new instance of the KeyValue with references to the key and value

pub const fn view_mut(&mut self) -> KeyValue<&mut K, &mut V>

returns a new instance of the KeyValue with mutable references to the current key and value

impl<K, V> KeyValue<&K, &V>

pub fn cloned(&self) -> KeyValue<K, V>

where K: Clone, V: Clone,

returns a new KeyValue instance with clones of the current key and value

pub fn copied(&self) -> KeyValue<K, V>

where K: Copy, V: Copy,

returns a new KeyValue instance with copies of the current key and value

impl<K, V> KeyValue<&K, &mut V>

pub fn cloned(&self) -> KeyValue<K, V>

where K: Clone, V: Clone,

returns a new KeyValue instance with clones of the current key and value

pub fn copied(&self) -> KeyValue<K, V>

where K: Copy, V: Copy,

returns a new KeyValue instance with copies of the current key and value

impl<K, V> KeyValue<&mut K, &mut V>

pub fn cloned(&self) -> KeyValue<K, V>

where K: Clone, V: Clone,

returns a new KeyValue instance with clones of the current key and value

pub fn copied(&self) -> KeyValue<K, V>

where K: Copy, V: Copy,

returns a new KeyValue instance with copies of the current key and value

Trait Implementations

impl<K: Clone, V: Clone> Clone for KeyValue<K, V>

fn clone(&self) -> KeyValue<K, V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for KeyValue<K, V>

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

Formats the value using the given formatter.

impl<K: Default, V: Default> Default for KeyValue<K, V>

fn default() -> KeyValue<K, V>

Returns the “default value” for a type.

impl<'de, K, V> Deserialize<'de> for KeyValue<K, V>

where K: Deserialize<'de>, V: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K, V> Display for KeyValue<K, V>

where K: Display, V: Display,

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

Formats the value using the given formatter.

impl<T> From<KeyValue<String, T>> for HyperParams<T>

fn from(kv: KeyValue<String, T>) -> Self

Converts to this type from the input type.

impl<K: Hash, V: Hash> Hash for KeyValue<K, V>

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<K: Ord, V: Ord> Ord for KeyValue<K, V>

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

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

Tests for self and other values to be equal, and is used by ==.

const 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<K: PartialOrd, V: PartialOrd> PartialOrd for KeyValue<K, V>

fn partial_cmp(&self, other: &KeyValue<K, V>) -> 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<K, V> Serialize for KeyValue<K, V>

where K: Serialize, V: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<K: Copy, V: Copy> Copy for KeyValue<K, V>

impl<K: Eq, V: Eq> Eq for KeyValue<K, V>

impl<K, V> StructuralPartialEq for KeyValue<K, V>