Skip to content

Commit

Permalink
Merge pull request #598 from SeaQL/hashable-value
Browse files Browse the repository at this point in the history 
Hashable value
  • Loading branch information
@tyt2y3
tyt2y3 authored Feb 20, 2023
2 parents 2d82347 + 8a7e3aa commit 813f7b4
Show file tree
Hide file tree
Showing 2 changed files with 213 additions and 6 deletions.
3 changes: 3 additions & 0 deletions Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ path = "src/lib.rs"
sea-query-attr = { version = "0.1.1", path = "sea-query-attr", default-features = false, optional = true }
sea-query-derive = { version = "0.3.0", path = "sea-query-derive", default-features = false, optional = true }
serde_json = { version = "1", default-features = false, optional = true, features = ["std"] }
derivative = { version = "2.2", default-features = false, optional = true }
chrono = { version = "0.4", default-features = false, optional = true, features = ["clock"] }
postgres-types = { version = "0", default-features = false, optional = true }
rust_decimal = { version = "1", default-features = false, optional = true }
Expand All @@ -40,6 +41,7 @@ quote = { version = "1", default-features = false, optional = true }
time = { version = "0.3", default-features = false, optional = true, features = ["macros", "formatting"] }
ipnetwork = { version = "0.19", default-features = false, optional = true }
mac_address = { version = "1.1", default-features = false, optional = true }
ordered-float = { version = "3.4", default-features = false, optional = true }

[dev-dependencies]
sea-query = { path = ".", features = ["tests-cfg"] }
Expand All @@ -53,6 +55,7 @@ backend-sqlite = []
default = ["derive", "backend-mysql", "backend-postgres", "backend-sqlite"]
derive = ["sea-query-derive"]
attr = ["sea-query-attr"]
hashable-value = ["derivative", "ordered-float"]
postgres-array = []
postgres-interval = ["proc-macro2", "quote"]
thread-safe = []
Expand Down
216 changes: 210 additions & 6 deletions src/value.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ use mac_address::MacAddress;
use crate::{BlobSize, ColumnType, CommonSqlQueryBuilder, QueryBuilder};

/// [`Value`] types variant for Postgres array
#[derive(Clone, Debug, Eq, PartialEq)]
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub enum ArrayType {
Bool,
TinyInt,
Expand Down Expand Up @@ -118,8 +118,17 @@ pub enum ArrayType {

/// Value variants
///
/// We want Value to be exactly 1 pointer sized, so anything larger should be boxed.
#[derive(Clone, Debug, PartialEq)]
/// We want the inner Value to be exactly 1 pointer sized, so anything larger should be boxed.
///
/// If the `hashable-value` feature is enabled, NaN == NaN, which contradicts Rust's built-in
/// implementation of NaN != NaN.
#[derive(Clone, Debug)]
#[cfg_attr(not(feature = "hashable-value"), derive(PartialEq))]
#[cfg_attr(
feature = "hashable-value",
derive(derivative::Derivative),
derivative(Hash, PartialEq, Eq)
)]
pub enum Value {
Bool(Option<bool>),
TinyInt(Option<i8>),
Expand All @@ -130,8 +139,26 @@ pub enum Value {
SmallUnsigned(Option<u16>),
Unsigned(Option<u32>),
BigUnsigned(Option<u64>),
Float(Option<f32>),
Double(Option<f64>),
Float(
#[cfg_attr(
feature = "hashable-value",
derivative(
Hash(hash_with = "hashable_value::hash_f32"),
PartialEq(compare_with = "hashable_value::cmp_f32")
)
)]
Option<f32>,
),
Double(
#[cfg_attr(
feature = "hashable-value",
derivative(
Hash(hash_with = "hashable_value::hash_f64"),
PartialEq(compare_with = "hashable_value::cmp_f64")
)
)]
Option<f64>,
),
String(Option<Box<String>>),
Char(Option<char>),

Expand All @@ -140,7 +167,16 @@ pub enum Value {

#[cfg(feature = "with-json")]
#[cfg_attr(docsrs, doc(cfg(feature = "with-json")))]
Json(Option<Box<Json>>),
Json(
#[cfg_attr(
feature = "hashable-value",
derivative(
Hash(hash_with = "hashable_value::hash_json"),
PartialEq(compare_with = "hashable_value::cmp_json")
)
)]
Option<Box<Json>>,
),

#[cfg(feature = "with-chrono")]
#[cfg_attr(docsrs, doc(cfg(feature = "with-chrono")))]
Expand Down Expand Up @@ -1874,3 +1910,171 @@ mod tests {
assert_eq!(out, None);
}
}

#[cfg(feature = "hashable-value")]
mod hashable_value {
use super::*;
use ordered_float::OrderedFloat;
use std::hash::{Hash, Hasher};

pub fn hash_f32<H: Hasher>(v: &Option<f32>, state: &mut H) {
match v {
Some(v) => OrderedFloat(*v).hash(state),
None => "null".hash(state),
}
}

pub fn hash_f64<H: Hasher>(v: &Option<f64>, state: &mut H) {
match v {
Some(v) => OrderedFloat(*v).hash(state),
None => "null".hash(state),
}
}

pub fn cmp_f32(l: &Option<f32>, r: &Option<f32>) -> bool {
match (l, r) {
(Some(l), Some(r)) => OrderedFloat(*l).eq(&OrderedFloat(*r)),
(None, None) => true,
_ => false,
}
}

pub fn cmp_f64(l: &Option<f64>, r: &Option<f64>) -> bool {
match (l, r) {
(Some(l), Some(r)) => OrderedFloat(*l).eq(&OrderedFloat(*r)),
(None, None) => true,
_ => false,
}
}

#[cfg(feature = "with-json")]
pub fn hash_json<H: Hasher>(v: &Option<Box<Json>>, state: &mut H) {
match v {
Some(v) => serde_json::to_string(v).unwrap().hash(state),
None => "null".hash(state),
}
}

#[cfg(feature = "with-json")]
pub fn cmp_json(l: &Option<Box<Json>>, r: &Option<Box<Json>>) -> bool {
match (l, r) {
(Some(l), Some(r)) => serde_json::to_string(l)
.unwrap()
.eq(&serde_json::to_string(r).unwrap()),
(None, None) => true,
_ => false,
}
}

#[test]
fn test_hash_value_0() {
let hash_set: std::collections::HashSet<Value> = [
Value::Int(None),
Value::Int(None),
Value::BigInt(None),
Value::BigInt(None),
Value::Float(None),
Value::Float(None), // Null is not NaN
Value::Float(Some(std::f32::NAN)), // NaN considered equal
Value::Float(Some(std::f32::NAN)),
Value::Double(None),
Value::Double(None),
Value::Double(Some(std::f64::NAN)),
Value::Double(Some(std::f64::NAN)),
]
.into_iter()
.collect();

let unique: std::collections::HashSet<Value> = [
Value::Int(None),
Value::BigInt(None),
Value::Float(None),
Value::Double(None),
Value::Float(Some(std::f32::NAN)),
Value::Double(Some(std::f64::NAN)),
]
.into_iter()
.collect();

assert_eq!(hash_set, unique);
}

#[test]
fn test_hash_value_1() {
let hash_set: std::collections::HashSet<Value> = [
Value::Int(None),
Value::Int(Some(1)),
Value::Int(Some(1)),
Value::BigInt(Some(2)),
Value::BigInt(Some(2)),
Value::Float(Some(3.0)),
Value::Float(Some(3.0)),
Value::Double(Some(3.0)),
Value::Double(Some(3.0)),
Value::BigInt(Some(5)),
]
.into_iter()
.collect();

let unique: std::collections::HashSet<Value> = [
Value::BigInt(Some(5)),
Value::Double(Some(3.0)),
Value::Float(Some(3.0)),
Value::BigInt(Some(2)),
Value::Int(Some(1)),
Value::Int(None),
]
.into_iter()
.collect();

assert_eq!(hash_set, unique);
}

#[cfg(feature = "postgres-array")]
#[test]
fn test_hash_value_array() {
assert_eq!(
Into::<Value>::into(vec![0i32, 1, 2]),
Value::Array(
ArrayType::Int,
Some(Box::new(vec![
Value::Int(Some(0)),
Value::Int(Some(1)),
Value::Int(Some(2))
]))
)
);

assert_eq!(
Into::<Value>::into(vec![0f32, 1.0, 2.0]),
Value::Array(
ArrayType::Float,
Some(Box::new(vec![
Value::Float(Some(0f32)),
Value::Float(Some(1.0)),
Value::Float(Some(2.0))
]))
)
);

let hash_set: std::collections::HashSet<Value> = [
Into::<Value>::into(vec![0i32, 1, 2]),
Into::<Value>::into(vec![0i32, 1, 2]),
Into::<Value>::into(vec![0f32, 1.0, 2.0]),
Into::<Value>::into(vec![0f32, 1.0, 2.0]),
Into::<Value>::into(vec![3f32, 2.0, 1.0]),
]
.into_iter()
.collect();

let unique: std::collections::HashSet<Value> = [
Into::<Value>::into(vec![0i32, 1, 2]),
Into::<Value>::into(vec![0f32, 1.0, 2.0]),
Into::<Value>::into(vec![3f32, 2.0, 1.0]),
]
.into_iter()
.collect();

assert_eq!(hash_set, unique);
}
}

0 comments on commit 813f7b4

Please sign in to comment.