Struct ichen_openprotocol::KeyValuePair

pub struct KeyValuePair<K, V> {
    pub key: K,
    pub value: V,
}

A general data structure holding a key and value pair.

Fields

key: K

value: V

Methods

impl<K, V> KeyValuePair<K, V>

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

Create a KewValuePair.

Examples

let kv = KeyValuePair::new("TheKey", 42.0);
assert_eq!(KeyValuePair { key: "TheKey", value: 42.0 }, kv);

impl<K: AsRef<str>> KeyValuePair<K, bool>

pub fn validate(&self) -> Result<'static, ()>

Validate a KeyValuePair data structure with a string-like key and boolean value by making sure that the key cannot be empty or all whitespace.

Errors

Returns Err(OpenProtocolError::EmptyField) if key is set to an empty string or is all whitespace.

Examples

let kv = KeyValuePair::new("    ", true);
assert_eq!(r#"Err(EmptyField("key"))"#, format!("{:?}", kv.validate()));

impl<K: AsRef<str>> KeyValuePair<K, f64>

pub fn validate(&self) -> Result<'static, ()>

Validate a KeyValuePair data structure with a string-like key and f64 value by making sure that the key cannot be empty or all whitespace, and that the value is a valid floating-point number.

Errors

Returns Err(OpenProtocolError::EmptyField) if key is set to an empty string or is all whitespace.

Returns Err(OpenProtocolError::InvalidField) if value is not a valid floating-point number.

Examples

let kv1 = KeyValuePair::new("     ", 42.0);
assert_eq!(r#"Err(EmptyField("key"))"#, format!("{:?}", kv1.validate()));

let kv2 = KeyValuePair::new("K2", std::f64::NAN);
assert_eq!(
    r#"Err(InvalidField { field: "value", value: "NaN", description: "NaN is not a supported value" })"#,
    format!("{:?}", kv2.validate())
);

Trait Implementations

impl<K: PartialEq, V: PartialEq> PartialEq<KeyValuePair<K, V>> for KeyValuePair<K, V>

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

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

fn ne(&self, other: &KeyValuePair<K, V>) -> bool

This method tests for !=.

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

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

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

Formats the value using the given formatter.

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

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

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<K, V> Serialize for KeyValuePair<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<'de, K, V> Deserialize<'de> for KeyValuePair<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.