Enum serde_hashkey::Key

pub enum Key<F = RejectFloatPolicy> where
    F: FloatPolicy,  {
    Unit,
    Bool(bool),
    Integer(Integer),
    Float(Float<F>),
    Bytes(Box<[u8]>),
    String(Box<str>),
    Seq(Box<[Key<F>]>),
    Map(Box<[(Key<F>, Key<F>)]>),
}

The central key type, which is an in-memory representation of all supported serde-serialized values.

This can be serialized to a type implementing serde::Deserialize using from_key, and deserialized from a type implementing serde::Serialize using to_key. See the corresponding function for documentation.

The type parameter F corresponds to the FloatPolicy in used. It defaults to RejectFloatPolicy which will cause floats to be rejected.

Examples

use serde_derive::{Deserialize, Serialize};
use serde_hashkey::{to_key, to_key_with_ordered_float};

#[derive(Debug, PartialEq, Eq, Serialize, Deserialize)]
struct Author {
    name: String,
    age: u32,
}

let key = to_key(&Author {
    name: String::from("Jane Doe"),
    age: 42,
})?;

// Note: serializing floats will fail under the default policy, but succeed
// under one supporting floats.
assert!(to_key(&42.0f32).is_err());
assert!(to_key_with_ordered_float(&42.0f32).is_ok());

Variants

Unit

A unit value.

Bool(bool)

A boolean value.

Integer(Integer)

An integer.

Float(Float<F>)

A 32-bit floating-point number.

Bytes(Box<[u8]>)

A byte array.

String(Box<str>)

A string.

Seq(Box<[Key<F>]>)

A vector.

Map(Box<[(Key<F>, Key<F>)]>)

A map.

Implementations

impl Key

pub fn normalize(self) -> Key

Normalize the key, making sure that all contained maps are sorted.

Trait Implementations

impl<F: Clone> Clone for Key<F> where
    F: FloatPolicy, 

pub fn clone(&self) -> Key<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for Key<F> where
    F: FloatPolicy, 

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

Formats the value using the given formatter.

impl Default for Key

pub fn default() -> Self

Returns the "default value" for a type.

impl<'de, F> Deserialize<'de> for Key<F> where
    F: FloatPolicy, 

Deserialize implementation for a Key.

This allows keys to be serialized immediately.

Examples

use serde_derive::Deserialize;
use serde_hashkey::{Key, OrderedFloatPolicy};

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Deserialize)]
struct Foo {
    key: Key<OrderedFloatPolicy>,
}

let foo: Foo = serde_json::from_str("{\"key\": 42.42}")?;

assert!(matches!(foo.key, Key::Float(..)));
Ok(())

pub fn deserialize<D>(deserializer: D) -> Result<Key<F>, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<F: Eq> Eq for Key<F> where
    F: FloatPolicy, 

impl<F> From<String> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: String) -> Key<F>

Performs the conversion.

impl<F> From<Vec<(Key<F>, Key<F>), Global>> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: Vec<(Key<F>, Key<F>)>) -> Key<F>

Performs the conversion.

impl<F> From<Vec<Key<F>, Global>> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: Vec<Key<F>>) -> Key<F>

Performs the conversion.

impl<F> From<Vec<u8, Global>> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: Vec<u8>) -> Key<F>

Performs the conversion.

impl<F> From<bool> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: bool) -> Key<F>

Performs the conversion.

impl<F> From<i128> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: i128) -> Key<F>

Performs the conversion.

impl<F> From<i16> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: i16) -> Key<F>

Performs the conversion.

impl<F> From<i32> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: i32) -> Key<F>

Performs the conversion.

impl<F> From<i64> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: i64) -> Key<F>

Performs the conversion.

impl<F> From<i8> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: i8) -> Key<F>

Performs the conversion.

impl<F> From<u128> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: u128) -> Key<F>

Performs the conversion.

impl<F> From<u16> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: u16) -> Key<F>

Performs the conversion.

impl<F> From<u32> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: u32) -> Key<F>

Performs the conversion.

impl<F> From<u64> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: u64) -> Key<F>

Performs the conversion.

impl<F> From<u8> for Key<F> where
    F: FloatPolicy, 

pub fn from(v: u8) -> Key<F>

Performs the conversion.

impl<F: Hash> Hash for Key<F> where
    F: FloatPolicy, 

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'de, F> IntoDeserializer<'de, Error> for &'de Key<F> where
    F: FloatPolicy, 

type Deserializer = Deserializer<'de, F>

The type of the deserializer being converted into.

pub fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl<F: Ord> Ord for Key<F> where
    F: FloatPolicy, 

pub fn cmp(&self, other: &Key<F>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<F: PartialEq> PartialEq<Key<F>> for Key<F> where
    F: FloatPolicy, 

pub fn eq(&self, other: &Key<F>) -> bool

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

pub fn ne(&self, other: &Key<F>) -> bool

This method tests for !=.

impl<F: PartialOrd> PartialOrd<Key<F>> for Key<F> where
    F: FloatPolicy, 

pub fn partial_cmp(&self, other: &Key<F>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &Key<F>) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Key<F>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &Key<F>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Key<F>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<F> Serialize for Key<F> where
    F: FloatPolicy, 

Serialize implementation for a Key.

This allows keys to be serialized immediately.

Examples

use serde_derive::Serialize;
use serde_hashkey::{Key, OrderedFloatPolicy, OrderedFloat, Float};

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize)]
struct Foo {
    key: Key<OrderedFloatPolicy>,
}

let foo: String = serde_json::to_string(&Foo { key: Key::Float(Float::F64(OrderedFloat(42.42f64))) })?;

assert_eq!(foo, "{\"key\":42.42}");
Ok(())

pub fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<F> StructuralEq for Key<F> where
    F: FloatPolicy, 

impl<F> StructuralPartialEq for Key<F> where
    F: FloatPolicy,