icydb_core/value/
mod.rs

1mod bytes;
2mod family;
3
4#[cfg(test)]
5mod tests;
6
7use crate::{
8    Key,
9    traits::{FieldValue, NumFromPrimitive},
10    types::*,
11};
12use candid::CandidType;
13use num_traits::ToPrimitive;
14use serde::{Deserialize, Serialize};
15use std::cmp::Ordering;
16
17pub use family::{ValueFamily, ValueFamilyExt};
18
19///
20/// CONSTANTS
21///
22
23const F64_SAFE_I64: i64 = 1i64 << 53;
24const F64_SAFE_U64: u64 = 1u64 << 53;
25const F64_SAFE_I128: i128 = 1i128 << 53;
26const F64_SAFE_U128: u128 = 1u128 << 53;
27
28///
29/// NumericRepr
30///
31
32enum NumericRepr {
33    Decimal(Decimal),
34    F64(f64),
35    None,
36}
37
38///
39/// TextMode
40///
41
42#[derive(Clone, Copy, Debug, Eq, PartialEq)]
43pub enum TextMode {
44    Cs, // case-sensitive
45    Ci, // case-insensitive
46}
47
48///
49/// Value
50/// can be used in WHERE statements
51///
52/// None        → the field’s value is Option::None (i.e., SQL NULL).
53/// Unit        → internal placeholder for RHS; not a real value.
54/// Unsupported → the field exists but isn’t filterable/indexable.
55///
56
57#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
58pub enum Value {
59    Account(Account),
60    Blob(Vec<u8>),
61    Bool(bool),
62    Date(Date),
63    Decimal(Decimal),
64    Duration(Duration),
65    Enum(ValueEnum),
66    E8s(E8s),
67    E18s(E18s),
68    Float32(Float32),
69    Float64(Float64),
70    Int(i64),
71    Int128(Int128),
72    IntBig(Int),
73    List(Vec<Self>),
74    None,
75    Principal(Principal),
76    Subaccount(Subaccount),
77    Text(String),
78    Timestamp(Timestamp),
79    Uint(u64),
80    Uint128(Nat128),
81    UintBig(Nat),
82    Ulid(Ulid),
83    Unit,
84    Unsupported,
85}
86
87impl Value {
88    ///
89    /// CONSTRUCTION
90    ///
91
92    /// Build a `Value::List` from a slice of items convertible into `Value`.
93    pub fn from_list<T: Into<Self> + Clone>(items: &[T]) -> Self {
94        Self::List(items.iter().cloned().map(Into::into).collect())
95    }
96
97    ///
98    /// TYPES
99    ///
100
101    /// Returns true if the value is one of the numeric-like variants
102    /// supported by numeric comparison/ordering.
103    #[must_use]
104    pub const fn is_numeric(&self) -> bool {
105        matches!(
106            self,
107            Self::Decimal(_)
108                | Self::Duration(_)
109                | Self::E8s(_)
110                | Self::E18s(_)
111                | Self::Float32(_)
112                | Self::Float64(_)
113                | Self::Int(_)
114                | Self::Int128(_)
115                | Self::Timestamp(_)
116                | Self::Uint(_)
117                | Self::Uint128(_)
118        )
119    }
120
121    /// Returns true if the value is Text.
122    #[must_use]
123    pub const fn is_text(&self) -> bool {
124        matches!(self, Self::Text(_))
125    }
126
127    /// Returns true if the value is Unit (used for presence/null comparators).
128    #[must_use]
129    pub const fn is_unit(&self) -> bool {
130        matches!(self, Self::Unit)
131    }
132
133    #[must_use]
134    pub const fn is_scalar(&self) -> bool {
135        match self {
136            // definitely not scalar:
137            Self::List(_) | Self::Unit => false,
138            _ => true,
139        }
140    }
141
142    fn numeric_repr(&self) -> NumericRepr {
143        if let Some(d) = self.to_decimal() {
144            return NumericRepr::Decimal(d);
145        }
146        if let Some(f) = self.to_f64_lossless() {
147            return NumericRepr::F64(f);
148        }
149        NumericRepr::None
150    }
151
152    ///
153    /// CONVERSION
154    ///
155
156    /// NOTE: `Unit` is intentionally treated as a valid key and indexable,
157    /// used for tables with exactly one row or synthetic “single identity”
158    /// entities. Only `None` and `Unsupported` are non-indexable.
159    #[must_use]
160    pub const fn as_key(&self) -> Option<Key> {
161        match self {
162            Self::Account(v) => Some(Key::Account(*v)),
163            Self::Int(v) => Some(Key::Int(*v)),
164            Self::Uint(v) => Some(Key::Uint(*v)),
165            Self::Principal(v) => Some(Key::Principal(*v)),
166            Self::Subaccount(v) => Some(Key::Subaccount(*v)),
167            Self::Ulid(v) => Some(Key::Ulid(*v)),
168            Self::Unit => Some(Key::Unit),
169            _ => None,
170        }
171    }
172
173    #[must_use]
174    pub const fn as_text(&self) -> Option<&str> {
175        if let Self::Text(s) = self {
176            Some(s.as_str())
177        } else {
178            None
179        }
180    }
181
182    #[must_use]
183    pub const fn as_list(&self) -> Option<&[Self]> {
184        if let Self::List(xs) = self {
185            Some(xs.as_slice())
186        } else {
187            None
188        }
189    }
190
191    fn to_decimal(&self) -> Option<Decimal> {
192        match self {
193            Self::Decimal(d) => Some(*d),
194            Self::Duration(d) => Decimal::from_u64(d.get()),
195            Self::E8s(v) => Some(v.to_decimal()),
196            Self::E18s(v) => Some(v.to_decimal()),
197            Self::Float64(f) => Decimal::from_f64(f.get()),
198            Self::Float32(f) => Decimal::from_f32(f.get()),
199            Self::Int(i) => Decimal::from_i64(*i),
200            Self::Int128(i) => Decimal::from_i128(i.get()),
201            Self::IntBig(i) => i.0.to_i128().and_then(Decimal::from_i128),
202            Self::Timestamp(t) => Decimal::from_u64(t.get()),
203            Self::Uint(u) => Decimal::from_u64(*u),
204            Self::Uint128(u) => Decimal::from_u128(u.get()),
205            Self::UintBig(u) => u.0.to_u128().and_then(Decimal::from_u128),
206
207            _ => None,
208        }
209    }
210
211    // it's lossless, trust me bro
212    #[allow(clippy::cast_precision_loss)]
213    fn to_f64_lossless(&self) -> Option<f64> {
214        match self {
215            Self::Duration(d) if d.get() <= F64_SAFE_U64 => Some(d.get() as f64),
216            Self::Float64(f) => Some(f.get()),
217            Self::Float32(f) => Some(f64::from(f.get())),
218            Self::Int(i) if (-F64_SAFE_I64..=F64_SAFE_I64).contains(i) => Some(*i as f64),
219            Self::Int128(i) if (-F64_SAFE_I128..=F64_SAFE_I128).contains(&i.get()) => {
220                Some(i.get() as f64)
221            }
222            Self::IntBig(i) => i.0.to_i128().and_then(|v| {
223                (-F64_SAFE_I128..=F64_SAFE_I128)
224                    .contains(&v)
225                    .then_some(v as f64)
226            }),
227            Self::Timestamp(t) if t.get() <= F64_SAFE_U64 => Some(t.get() as f64),
228            Self::Uint(u) if *u <= F64_SAFE_U64 => Some(*u as f64),
229            Self::Uint128(u) if u.get() <= F64_SAFE_U128 => Some(u.get() as f64),
230            Self::UintBig(u) => {
231                u.0.to_u128()
232                    .and_then(|v| (v <= F64_SAFE_U128).then_some(v as f64))
233            }
234
235            _ => None,
236        }
237    }
238
239    #[must_use]
240    /// Stable 128-bit hash used for index keys; returns `None` for non-indexable values.
241    pub fn to_index_fingerprint(&self) -> Option<[u8; 16]> {
242        match self {
243            Self::None | Self::Unsupported => None,
244            _ => Some(self.hash_value()),
245        }
246    }
247
248    /// Cross-type numeric comparison; returns None if non-numeric.
249    #[must_use]
250    pub fn cmp_numeric(&self, other: &Self) -> Option<Ordering> {
251        match (self.numeric_repr(), other.numeric_repr()) {
252            (NumericRepr::Decimal(a), NumericRepr::Decimal(b)) => a.partial_cmp(&b),
253            (NumericRepr::F64(a), NumericRepr::F64(b)) => a.partial_cmp(&b),
254            _ => None,
255        }
256    }
257
258    ///
259    /// TEXT COMPARISON
260    ///
261
262    #[inline]
263    fn fold_ci(s: &str) -> std::borrow::Cow<'_, str> {
264        if s.is_ascii() {
265            return std::borrow::Cow::Owned(s.to_ascii_lowercase());
266        }
267        // NOTE: Unicode fallback — temporary to_lowercase for non‑ASCII.
268        // Future: replace with proper NFKC + full casefold when available.
269        std::borrow::Cow::Owned(s.to_lowercase())
270    }
271
272    #[inline]
273    fn text_with_mode(s: &'_ str, mode: TextMode) -> std::borrow::Cow<'_, str> {
274        match mode {
275            TextMode::Cs => std::borrow::Cow::Borrowed(s),
276            TextMode::Ci => Self::fold_ci(s),
277        }
278    }
279
280    #[inline]
281    fn text_op(
282        &self,
283        other: &Self,
284        mode: TextMode,
285        f: impl Fn(&str, &str) -> bool,
286    ) -> Option<bool> {
287        let (a, b) = (self.as_text()?, other.as_text()?);
288        let a = Self::text_with_mode(a, mode);
289        let b = Self::text_with_mode(b, mode);
290        Some(f(&a, &b))
291    }
292
293    #[inline]
294    fn ci_key(&self) -> Option<String> {
295        match self {
296            Self::Text(s) => Some(Self::fold_ci(s).into_owned()),
297            Self::Ulid(u) => Some(u.to_string().to_ascii_lowercase()),
298            Self::Principal(p) => Some(p.to_string().to_ascii_lowercase()),
299            Self::Account(a) => Some(a.to_string().to_ascii_lowercase()),
300            _ => None,
301        }
302    }
303
304    fn eq_ci(a: &Self, b: &Self) -> bool {
305        if let (Some(ak), Some(bk)) = (a.ci_key(), b.ci_key()) {
306            return ak == bk;
307        }
308
309        a == b
310    }
311
312    #[inline]
313    fn normalize_list_ref(v: &Self) -> Vec<&Self> {
314        match v {
315            Self::List(vs) => vs.iter().collect(),
316            v => vec![v],
317        }
318    }
319
320    #[inline]
321    fn contains_by<F>(&self, needle: &Self, eq: F) -> Option<bool>
322    where
323        F: Fn(&Self, &Self) -> bool,
324    {
325        self.as_list()
326            .map(|items| items.iter().any(|v| eq(v, needle)))
327    }
328
329    #[inline]
330    #[allow(clippy::unnecessary_wraps)]
331    fn contains_any_by<F>(&self, needles: &Self, eq: F) -> Option<bool>
332    where
333        F: Fn(&Self, &Self) -> bool,
334    {
335        let needles = Self::normalize_list_ref(needles);
336        match self {
337            Self::List(items) => Some(needles.iter().any(|n| items.iter().any(|v| eq(v, n)))),
338            scalar => Some(needles.iter().any(|n| eq(scalar, n))),
339        }
340    }
341
342    #[inline]
343    #[allow(clippy::unnecessary_wraps)]
344    fn contains_all_by<F>(&self, needles: &Self, eq: F) -> Option<bool>
345    where
346        F: Fn(&Self, &Self) -> bool,
347    {
348        let needles = Self::normalize_list_ref(needles);
349        match self {
350            Self::List(items) => Some(needles.iter().all(|n| items.iter().any(|v| eq(v, n)))),
351            scalar => Some(needles.len() == 1 && eq(scalar, needles[0])),
352        }
353    }
354
355    #[inline]
356    fn in_list_by<F>(&self, haystack: &Self, eq: F) -> Option<bool>
357    where
358        F: Fn(&Self, &Self) -> bool,
359    {
360        if let Self::List(items) = haystack {
361            Some(items.iter().any(|h| eq(h, self)))
362        } else {
363            None
364        }
365    }
366
367    #[must_use]
368    /// Case-sensitive/insensitive equality check for text-like values.
369    pub fn text_eq(&self, other: &Self, mode: TextMode) -> Option<bool> {
370        self.text_op(other, mode, |a, b| a == b)
371    }
372
373    #[must_use]
374    /// Check whether `other` is a substring of `self` under the given text mode.
375    pub fn text_contains(&self, needle: &Self, mode: TextMode) -> Option<bool> {
376        self.text_op(needle, mode, |a, b| a.contains(b))
377    }
378
379    #[must_use]
380    /// Check whether `self` starts with `other` under the given text mode.
381    pub fn text_starts_with(&self, needle: &Self, mode: TextMode) -> Option<bool> {
382        self.text_op(needle, mode, |a, b| a.starts_with(b))
383    }
384
385    #[must_use]
386    /// Check whether `self` ends with `other` under the given text mode.
387    pub fn text_ends_with(&self, needle: &Self, mode: TextMode) -> Option<bool> {
388        self.text_op(needle, mode, |a, b| a.ends_with(b))
389    }
390
391    ///
392    /// EMPTY
393    ///
394
395    #[must_use]
396    pub const fn is_empty(&self) -> Option<bool> {
397        match self {
398            Self::List(xs) => Some(xs.is_empty()),
399            Self::Text(s) => Some(s.is_empty()),
400            Self::Blob(b) => Some(b.is_empty()),
401
402            //  fields represented as Value::None:
403            Self::None => Some(true),
404
405            _ => None,
406        }
407    }
408
409    #[must_use]
410    /// Logical negation of [`is_empty`](Self::is_empty).
411    pub fn is_not_empty(&self) -> Option<bool> {
412        self.is_empty().map(|b| !b)
413    }
414
415    ///
416    /// COLLECTIONS
417    ///
418
419    #[must_use]
420    /// Returns true if `self` contains `needle` (or equals it for scalars).
421    pub fn contains(&self, needle: &Self) -> Option<bool> {
422        self.contains_by(needle, |a, b| a == b)
423    }
424
425    #[must_use]
426    /// Returns true if any item in `needles` matches a member of `self`.
427    pub fn contains_any(&self, needles: &Self) -> Option<bool> {
428        self.contains_any_by(needles, |a, b| a == b)
429    }
430
431    #[must_use]
432    /// Returns true if every item in `needles` matches a member of `self`.
433    pub fn contains_all(&self, needles: &Self) -> Option<bool> {
434        self.contains_all_by(needles, |a, b| a == b)
435    }
436
437    #[must_use]
438    /// Returns true if `self` exists inside the provided list.
439    pub fn in_list(&self, haystack: &Self) -> Option<bool> {
440        self.in_list_by(haystack, |a, b| a == b)
441    }
442
443    #[must_use]
444    /// Case-insensitive `contains` supporting text and identifier variants.
445    pub fn contains_ci(&self, needle: &Self) -> Option<bool> {
446        match self {
447            Self::List(_) => self.contains_by(needle, Self::eq_ci),
448            _ => Some(Self::eq_ci(self, needle)),
449        }
450    }
451
452    #[must_use]
453    /// Case-insensitive variant of [`contains_any`](Self::contains_any).
454    pub fn contains_any_ci(&self, needles: &Self) -> Option<bool> {
455        self.contains_any_by(needles, Self::eq_ci)
456    }
457
458    #[must_use]
459    /// Case-insensitive variant of [`contains_all`](Self::contains_all).
460    pub fn contains_all_ci(&self, needles: &Self) -> Option<bool> {
461        self.contains_all_by(needles, Self::eq_ci)
462    }
463
464    #[must_use]
465    /// Case-insensitive variant of [`in_list`](Self::in_list).
466    pub fn in_list_ci(&self, haystack: &Self) -> Option<bool> {
467        self.in_list_by(haystack, Self::eq_ci)
468    }
469}
470
471#[macro_export]
472macro_rules! impl_from_for {
473    ( $( $type:ty => $variant:ident ),* $(,)? ) => {
474        $(
475            impl From<$type> for Value {
476                fn from(v: $type) -> Self {
477                    Self::$variant(v.into())
478                }
479            }
480        )*
481    };
482}
483
484impl_from_for! {
485    Account    => Account,
486    Date       => Date,
487    Decimal    => Decimal,
488    Duration   => Duration,
489    E8s        => E8s,
490    E18s       => E18s,
491    bool       => Bool,
492    i8         => Int,
493    i16        => Int,
494    i32        => Int,
495    i64        => Int,
496    i128       => Int128,
497    Int        => IntBig,
498    Principal  => Principal,
499    Subaccount => Subaccount,
500    &str       => Text,
501    String     => Text,
502    Timestamp  => Timestamp,
503    u8         => Uint,
504    u16        => Uint,
505    u32        => Uint,
506    u64        => Uint,
507    u128       => Uint128,
508    Nat        => UintBig,
509    Ulid       => Ulid,
510}
511
512impl ValueFamilyExt for Value {
513    fn family(&self) -> ValueFamily {
514        match self {
515            // Numeric
516            Self::Date(_)
517            | Self::Decimal(_)
518            | Self::Duration(_)
519            | Self::E8s(_)
520            | Self::E18s(_)
521            | Self::Float32(_)
522            | Self::Float64(_)
523            | Self::Int(_)
524            | Self::Int128(_)
525            | Self::Timestamp(_)
526            | Self::Uint(_)
527            | Self::Uint128(_)
528            | Self::IntBig(_)
529            | Self::UintBig(_) => ValueFamily::Numeric,
530
531            // Text
532            Self::Text(_) => ValueFamily::Textual,
533
534            // Identifiers
535            Self::Ulid(_) | Self::Principal(_) | Self::Account(_) => ValueFamily::Identifier,
536
537            // Enum
538            Self::Enum(_) => ValueFamily::Enum,
539
540            // Collections
541            Self::List(_) => ValueFamily::Collection,
542
543            // Blobs
544            Self::Blob(_) | Self::Subaccount(_) => ValueFamily::Blob,
545
546            // Bool
547            Self::Bool(_) => ValueFamily::Bool,
548
549            // Null / Unit
550            Self::None => ValueFamily::Null,
551            Self::Unit => ValueFamily::Unit,
552
553            // Everything else
554            Self::Unsupported => ValueFamily::Unsupported,
555        }
556    }
557}
558
559impl FieldValue for Value {
560    fn to_value(&self) -> Value {
561        self.clone()
562    }
563}
564
565impl From<Vec<Self>> for Value {
566    fn from(vec: Vec<Self>) -> Self {
567        Self::List(vec)
568    }
569}
570
571impl From<()> for Value {
572    fn from((): ()) -> Self {
573        Self::Unit
574    }
575}
576
577impl PartialOrd for Value {
578    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
579        match (self, other) {
580            (Self::Bool(a), Self::Bool(b)) => a.partial_cmp(b),
581            (Self::Date(a), Self::Date(b)) => a.partial_cmp(b),
582            (Self::Decimal(a), Self::Decimal(b)) => a.partial_cmp(b),
583            (Self::Duration(a), Self::Duration(b)) => a.partial_cmp(b),
584            (Self::E8s(a), Self::E8s(b)) => a.partial_cmp(b),
585            (Self::E18s(a), Self::E18s(b)) => a.partial_cmp(b),
586            (Self::Float32(a), Self::Float32(b)) => a.partial_cmp(b),
587            (Self::Float64(a), Self::Float64(b)) => a.partial_cmp(b),
588            (Self::Int(a), Self::Int(b)) => a.partial_cmp(b),
589            (Self::Int128(a), Self::Int128(b)) => a.partial_cmp(b),
590            (Self::IntBig(a), Self::IntBig(b)) => a.partial_cmp(b),
591            (Self::Principal(a), Self::Principal(b)) => a.partial_cmp(b),
592            (Self::Subaccount(a), Self::Subaccount(b)) => a.partial_cmp(b),
593            (Self::Text(a), Self::Text(b)) => a.partial_cmp(b),
594            (Self::Timestamp(a), Self::Timestamp(b)) => a.partial_cmp(b),
595            (Self::Uint(a), Self::Uint(b)) => a.partial_cmp(b),
596            (Self::Uint128(a), Self::Uint128(b)) => a.partial_cmp(b),
597            (Self::UintBig(a), Self::UintBig(b)) => a.partial_cmp(b),
598            (Self::Ulid(a), Self::Ulid(b)) => a.partial_cmp(b),
599
600            // Cross-type comparisons: no ordering
601            _ => None,
602        }
603    }
604}
605
606///
607/// ValueEnum
608/// handles the Enum case; `path` is optional to allow strict (typed) or loose matching.
609///
610
611#[derive(CandidType, Clone, Debug, Deserialize, Eq, PartialEq, PartialOrd, Serialize)]
612pub struct ValueEnum {
613    pub variant: String,
614    pub path: Option<String>,
615    pub payload: Option<Box<Value>>,
616}
617
618impl ValueEnum {
619    #[must_use]
620    /// Build a strict enum value matching the provided variant and path.
621    pub fn new(variant: &str, path: Option<&str>) -> Self {
622        Self {
623            variant: variant.to_string(),
624            path: path.map(ToString::to_string),
625            payload: None,
626        }
627    }
628
629    #[must_use]
630    /// Build an enum value that ignores the path for loose matching.
631    pub fn loose(variant: &str) -> Self {
632        Self::new(variant, None)
633    }
634
635    #[must_use]
636    /// Attach an enum payload (used for data-carrying variants).
637    pub fn with_payload(mut self, payload: Value) -> Self {
638        self.payload = Some(Box::new(payload));
639        self
640    }
641}
icydb_core/value/mod.rs

icydb_core/value/
mod.rs
