Skip to main content

reifydb_type/value/
mod.rs

1// SPDX-License-Identifier: MIT
2// Copyright (c) 2025 ReifyDB
3
4use std::{
5	cmp::Ordering,
6	fmt::{Display, Formatter},
7};
8
9use serde::{Deserialize, Serialize};
10
11pub mod as_string;
12pub mod blob;
13pub mod boolean;
14pub mod constraint;
15pub mod container;
16pub mod date;
17pub mod datetime;
18pub mod decimal;
19pub mod dictionary;
20pub mod duration;
21pub mod frame;
22pub mod identity;
23pub mod int;
24pub mod into;
25pub mod is;
26pub mod number;
27pub mod ordered_f32;
28pub mod ordered_f64;
29pub mod row_number;
30pub mod sumtype;
31pub mod temporal;
32pub mod time;
33pub mod try_from;
34pub mod r#type;
35pub mod uint;
36pub mod uuid;
37
38use blob::Blob;
39use date::Date;
40use datetime::DateTime;
41use decimal::Decimal;
42use dictionary::DictionaryEntryId;
43use duration::Duration;
44use identity::IdentityId;
45use int::Int;
46use ordered_f32::OrderedF32;
47use ordered_f64::OrderedF64;
48use time::Time;
49use r#type::Type;
50use uint::Uint;
51use uuid::{Uuid4, Uuid7};
52
53/// A RQL value, represented as a native Rust type.
54#[derive(Clone, Debug, Serialize, Deserialize)]
55pub enum Value {
56	/// Value is none (think null in common programming languages)
57	None {
58		#[serde(skip, default = "default_none_inner")]
59		inner: Type,
60	},
61	/// A boolean: true or false.
62	Boolean(bool),
63	/// A 4-byte floating point
64	Float4(OrderedF32),
65	/// An 8-byte floating point
66	Float8(OrderedF64),
67	/// A 1-byte signed integer
68	Int1(i8),
69	/// A 2-byte signed integer
70	Int2(i16),
71	/// A 4-byte signed integer
72	Int4(i32),
73	/// An 8-byte signed integer
74	Int8(i64),
75	/// A 16-byte signed integer
76	Int16(i128),
77	/// A UTF-8 encoded text. Maximum 255 bytes
78	Utf8(String),
79	/// A 1-byte unsigned integer
80	Uint1(u8),
81	/// A 2-byte unsigned integer
82	Uint2(u16),
83	/// A 4-byte unsigned integer
84	Uint4(u32),
85	/// A 8-byte unsigned integer
86	Uint8(u64),
87	/// A 16-byte unsigned integer
88	Uint16(u128),
89	/// A date value (year, month, day)
90	Date(Date),
91	/// A date and time value with nanosecond precision in SVTC
92	DateTime(DateTime),
93	/// A time value (hour, minute, second, nanosecond)
94	Time(Time),
95	/// A duration representing a duration
96	Duration(Duration),
97	/// An identity identifier (UUID v7)
98	IdentityId(IdentityId),
99	/// A UUID version 4 (random)
100	Uuid4(Uuid4),
101	/// A UUID version 7 (timestamp-based)
102	Uuid7(Uuid7),
103	/// A binary large object (BLOB)
104	Blob(Blob),
105	/// An arbitrary-precision signed integer
106	Int(Int),
107	/// An arbitrary-precision unsigned integer
108	Uint(Uint),
109	/// An arbitrary-precision decimal
110	Decimal(Decimal),
111	/// A container that can hold any value type
112	Any(Box<Value>),
113	/// A dictionary entry identifier
114	DictionaryId(DictionaryEntryId),
115	/// A type value (first-class type identifier)
116	Type(Type),
117}
118
119fn default_none_inner() -> Type {
120	Type::Any
121}
122
123impl Value {
124	pub fn none() -> Self {
125		Value::None {
126			inner: Type::Any,
127		}
128	}
129
130	pub fn none_of(ty: Type) -> Self {
131		Value::None {
132			inner: ty,
133		}
134	}
135
136	pub fn bool(v: impl Into<bool>) -> Self {
137		Value::Boolean(v.into())
138	}
139
140	pub fn float4(v: impl Into<f32>) -> Self {
141		OrderedF32::try_from(v.into()).map(Value::Float4).unwrap_or(Value::None {
142			inner: Type::Float4,
143		})
144	}
145
146	pub fn float8(v: impl Into<f64>) -> Self {
147		OrderedF64::try_from(v.into()).map(Value::Float8).unwrap_or(Value::None {
148			inner: Type::Float8,
149		})
150	}
151
152	pub fn int1(v: impl Into<i8>) -> Self {
153		Value::Int1(v.into())
154	}
155
156	pub fn int2(v: impl Into<i16>) -> Self {
157		Value::Int2(v.into())
158	}
159
160	pub fn int4(v: impl Into<i32>) -> Self {
161		Value::Int4(v.into())
162	}
163
164	pub fn int8(v: impl Into<i64>) -> Self {
165		Value::Int8(v.into())
166	}
167
168	pub fn int16(v: impl Into<i128>) -> Self {
169		Value::Int16(v.into())
170	}
171
172	pub fn utf8(v: impl Into<String>) -> Self {
173		Value::Utf8(v.into())
174	}
175
176	pub fn uint1(v: impl Into<u8>) -> Self {
177		Value::Uint1(v.into())
178	}
179
180	pub fn uint2(v: impl Into<u16>) -> Self {
181		Value::Uint2(v.into())
182	}
183
184	pub fn uint4(v: impl Into<u32>) -> Self {
185		Value::Uint4(v.into())
186	}
187
188	pub fn uint8(v: impl Into<u64>) -> Self {
189		Value::Uint8(v.into())
190	}
191
192	pub fn uint16(v: impl Into<u128>) -> Self {
193		Value::Uint16(v.into())
194	}
195
196	pub fn date(v: impl Into<Date>) -> Self {
197		Value::Date(v.into())
198	}
199
200	pub fn datetime(v: impl Into<DateTime>) -> Self {
201		Value::DateTime(v.into())
202	}
203
204	pub fn time(v: impl Into<Time>) -> Self {
205		Value::Time(v.into())
206	}
207
208	pub fn duration(v: impl Into<Duration>) -> Self {
209		Value::Duration(v.into())
210	}
211
212	pub fn identity_id(v: impl Into<IdentityId>) -> Self {
213		Value::IdentityId(v.into())
214	}
215
216	pub fn uuid4(v: impl Into<Uuid4>) -> Self {
217		Value::Uuid4(v.into())
218	}
219
220	pub fn uuid7(v: impl Into<Uuid7>) -> Self {
221		Value::Uuid7(v.into())
222	}
223
224	pub fn blob(v: impl Into<Blob>) -> Self {
225		Value::Blob(v.into())
226	}
227
228	pub fn any(v: impl Into<Value>) -> Self {
229		Value::Any(Box::new(v.into()))
230	}
231}
232
233impl PartialEq for Value {
234	fn eq(&self, other: &Self) -> bool {
235		match (self, other) {
236			(
237				Value::None {
238					..
239				},
240				Value::None {
241					..
242				},
243			) => true,
244			(Value::Boolean(l), Value::Boolean(r)) => l == r,
245			(Value::Float4(l), Value::Float4(r)) => l == r,
246			(Value::Float8(l), Value::Float8(r)) => l == r,
247			(Value::Int1(l), Value::Int1(r)) => l == r,
248			(Value::Int2(l), Value::Int2(r)) => l == r,
249			(Value::Int4(l), Value::Int4(r)) => l == r,
250			(Value::Int8(l), Value::Int8(r)) => l == r,
251			(Value::Int16(l), Value::Int16(r)) => l == r,
252			(Value::Utf8(l), Value::Utf8(r)) => l == r,
253			(Value::Uint1(l), Value::Uint1(r)) => l == r,
254			(Value::Uint2(l), Value::Uint2(r)) => l == r,
255			(Value::Uint4(l), Value::Uint4(r)) => l == r,
256			(Value::Uint8(l), Value::Uint8(r)) => l == r,
257			(Value::Uint16(l), Value::Uint16(r)) => l == r,
258			(Value::Date(l), Value::Date(r)) => l == r,
259			(Value::DateTime(l), Value::DateTime(r)) => l == r,
260			(Value::Time(l), Value::Time(r)) => l == r,
261			(Value::Duration(l), Value::Duration(r)) => l == r,
262			(Value::IdentityId(l), Value::IdentityId(r)) => l == r,
263			(Value::Uuid4(l), Value::Uuid4(r)) => l == r,
264			(Value::Uuid7(l), Value::Uuid7(r)) => l == r,
265			(Value::Blob(l), Value::Blob(r)) => l == r,
266			(Value::Int(l), Value::Int(r)) => l == r,
267			(Value::Uint(l), Value::Uint(r)) => l == r,
268			(Value::Decimal(l), Value::Decimal(r)) => l == r,
269			(Value::Any(l), Value::Any(r)) => l == r,
270			(Value::DictionaryId(l), Value::DictionaryId(r)) => l == r,
271			(Value::Type(l), Value::Type(r)) => l == r,
272			_ => false,
273		}
274	}
275}
276
277impl Eq for Value {}
278
279impl std::hash::Hash for Value {
280	fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
281		std::mem::discriminant(self).hash(state);
282		match self {
283			Value::None {
284				..
285			} => {} // All Nones hash identically
286			Value::Boolean(v) => v.hash(state),
287			Value::Float4(v) => v.hash(state),
288			Value::Float8(v) => v.hash(state),
289			Value::Int1(v) => v.hash(state),
290			Value::Int2(v) => v.hash(state),
291			Value::Int4(v) => v.hash(state),
292			Value::Int8(v) => v.hash(state),
293			Value::Int16(v) => v.hash(state),
294			Value::Utf8(v) => v.hash(state),
295			Value::Uint1(v) => v.hash(state),
296			Value::Uint2(v) => v.hash(state),
297			Value::Uint4(v) => v.hash(state),
298			Value::Uint8(v) => v.hash(state),
299			Value::Uint16(v) => v.hash(state),
300			Value::Date(v) => v.hash(state),
301			Value::DateTime(v) => v.hash(state),
302			Value::Time(v) => v.hash(state),
303			Value::Duration(v) => v.hash(state),
304			Value::IdentityId(v) => v.hash(state),
305			Value::Uuid4(v) => v.hash(state),
306			Value::Uuid7(v) => v.hash(state),
307			Value::Blob(v) => v.hash(state),
308			Value::Int(v) => v.hash(state),
309			Value::Uint(v) => v.hash(state),
310			Value::Decimal(v) => v.hash(state),
311			Value::Any(v) => v.hash(state),
312			Value::DictionaryId(v) => v.hash(state),
313			Value::Type(v) => v.hash(state),
314		}
315	}
316}
317
318impl PartialOrd for Value {
319	fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
320		match (self, other) {
321			(Value::Boolean(l), Value::Boolean(r)) => l.partial_cmp(r),
322			(Value::Float4(l), Value::Float4(r)) => l.partial_cmp(r),
323			(Value::Float8(l), Value::Float8(r)) => l.partial_cmp(r),
324			(Value::Int1(l), Value::Int1(r)) => l.partial_cmp(r),
325			(Value::Int2(l), Value::Int2(r)) => l.partial_cmp(r),
326			(Value::Int4(l), Value::Int4(r)) => l.partial_cmp(r),
327			(Value::Int8(l), Value::Int8(r)) => l.partial_cmp(r),
328			(Value::Int16(l), Value::Int16(r)) => l.partial_cmp(r),
329			(Value::Utf8(l), Value::Utf8(r)) => l.partial_cmp(r),
330			(Value::Uint1(l), Value::Uint1(r)) => l.partial_cmp(r),
331			(Value::Uint2(l), Value::Uint2(r)) => l.partial_cmp(r),
332			(Value::Uint4(l), Value::Uint4(r)) => l.partial_cmp(r),
333			(Value::Uint8(l), Value::Uint8(r)) => l.partial_cmp(r),
334			(Value::Uint16(l), Value::Uint16(r)) => l.partial_cmp(r),
335			(Value::Date(l), Value::Date(r)) => l.partial_cmp(r),
336			(Value::DateTime(l), Value::DateTime(r)) => l.partial_cmp(r),
337			(Value::Time(l), Value::Time(r)) => l.partial_cmp(r),
338			(Value::Duration(l), Value::Duration(r)) => l.partial_cmp(r),
339			(Value::IdentityId(l), Value::IdentityId(r)) => l.partial_cmp(r),
340			(Value::Uuid4(l), Value::Uuid4(r)) => l.partial_cmp(r),
341			(Value::Uuid7(l), Value::Uuid7(r)) => l.partial_cmp(r),
342			(Value::Blob(l), Value::Blob(r)) => l.partial_cmp(r),
343			(Value::Int(l), Value::Int(r)) => l.partial_cmp(r),
344			(Value::Uint(l), Value::Uint(r)) => l.partial_cmp(r),
345			(Value::Decimal(l), Value::Decimal(r)) => l.partial_cmp(r),
346			(Value::DictionaryId(l), Value::DictionaryId(r)) => l.to_u128().partial_cmp(&r.to_u128()),
347			(Value::Type(l), Value::Type(r)) => l.partial_cmp(r),
348			(Value::Any(_), Value::Any(_)) => None, // Any values are not comparable
349			(
350				Value::None {
351					..
352				},
353				Value::None {
354					..
355				},
356			) => Some(Ordering::Equal),
357			// None sorts after all other values (similar to NULL in SQL)
358			(
359				Value::None {
360					..
361				},
362				_,
363			) => Some(Ordering::Greater),
364			(
365				_,
366				Value::None {
367					..
368				},
369			) => Some(Ordering::Less),
370			(left, right) => {
371				unimplemented!("partial cmp {left:?} {right:?}")
372			}
373		}
374	}
375}
376
377impl Ord for Value {
378	fn cmp(&self, other: &Self) -> Ordering {
379		match (self, other) {
380			(
381				Value::None {
382					..
383				},
384				Value::None {
385					..
386				},
387			) => Ordering::Equal,
388			(
389				Value::None {
390					..
391				},
392				_,
393			) => Ordering::Greater,
394			(
395				_,
396				Value::None {
397					..
398				},
399			) => Ordering::Less,
400			(Value::Boolean(l), Value::Boolean(r)) => l.cmp(r),
401			(Value::Float4(l), Value::Float4(r)) => l.cmp(r),
402			(Value::Float8(l), Value::Float8(r)) => l.cmp(r),
403			(Value::Int1(l), Value::Int1(r)) => l.cmp(r),
404			(Value::Int2(l), Value::Int2(r)) => l.cmp(r),
405			(Value::Int4(l), Value::Int4(r)) => l.cmp(r),
406			(Value::Int8(l), Value::Int8(r)) => l.cmp(r),
407			(Value::Int16(l), Value::Int16(r)) => l.cmp(r),
408			(Value::Utf8(l), Value::Utf8(r)) => l.cmp(r),
409			(Value::Uint1(l), Value::Uint1(r)) => l.cmp(r),
410			(Value::Uint2(l), Value::Uint2(r)) => l.cmp(r),
411			(Value::Uint4(l), Value::Uint4(r)) => l.cmp(r),
412			(Value::Uint8(l), Value::Uint8(r)) => l.cmp(r),
413			(Value::Uint16(l), Value::Uint16(r)) => l.cmp(r),
414			(Value::Date(l), Value::Date(r)) => l.cmp(r),
415			(Value::DateTime(l), Value::DateTime(r)) => l.cmp(r),
416			(Value::Time(l), Value::Time(r)) => l.cmp(r),
417			(Value::Duration(l), Value::Duration(r)) => l.cmp(r),
418			(Value::IdentityId(l), Value::IdentityId(r)) => l.cmp(r),
419			(Value::Uuid4(l), Value::Uuid4(r)) => l.cmp(r),
420			(Value::Uuid7(l), Value::Uuid7(r)) => l.cmp(r),
421			(Value::Blob(l), Value::Blob(r)) => l.cmp(r),
422			(Value::Int(l), Value::Int(r)) => l.cmp(r),
423			(Value::Uint(l), Value::Uint(r)) => l.cmp(r),
424			(Value::Decimal(l), Value::Decimal(r)) => l.cmp(r),
425			(Value::DictionaryId(l), Value::DictionaryId(r)) => l.to_u128().cmp(&r.to_u128()),
426			(Value::Type(l), Value::Type(r)) => l.cmp(r),
427			(Value::Any(_), Value::Any(_)) => unreachable!("Any values are not orderable"),
428			_ => unimplemented!(),
429		}
430	}
431}
432
433impl Display for Value {
434	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
435		match self {
436			Value::Boolean(true) => f.write_str("true"),
437			Value::Boolean(false) => f.write_str("false"),
438			Value::Float4(value) => Display::fmt(value, f),
439			Value::Float8(value) => Display::fmt(value, f),
440			Value::Int1(value) => Display::fmt(value, f),
441			Value::Int2(value) => Display::fmt(value, f),
442			Value::Int4(value) => Display::fmt(value, f),
443			Value::Int8(value) => Display::fmt(value, f),
444			Value::Int16(value) => Display::fmt(value, f),
445			Value::Utf8(value) => Display::fmt(value, f),
446			Value::Uint1(value) => Display::fmt(value, f),
447			Value::Uint2(value) => Display::fmt(value, f),
448			Value::Uint4(value) => Display::fmt(value, f),
449			Value::Uint8(value) => Display::fmt(value, f),
450			Value::Uint16(value) => Display::fmt(value, f),
451			Value::Date(value) => Display::fmt(value, f),
452			Value::DateTime(value) => Display::fmt(value, f),
453			Value::Time(value) => Display::fmt(value, f),
454			Value::Duration(value) => Display::fmt(value, f),
455			Value::IdentityId(value) => Display::fmt(value, f),
456			Value::Uuid4(value) => Display::fmt(value, f),
457			Value::Uuid7(value) => Display::fmt(value, f),
458			Value::Blob(value) => Display::fmt(value, f),
459			Value::Int(value) => Display::fmt(value, f),
460			Value::Uint(value) => Display::fmt(value, f),
461			Value::Decimal(value) => Display::fmt(value, f),
462			Value::Any(value) => Display::fmt(value, f),
463			Value::DictionaryId(value) => Display::fmt(value, f),
464			Value::Type(value) => Display::fmt(value, f),
465			Value::None {
466				..
467			} => f.write_str("none"),
468		}
469	}
470}
471
472impl Value {
473	pub fn get_type(&self) -> Type {
474		match self {
475			Value::None {
476				inner,
477			} => Type::Option(Box::new(inner.clone())),
478			Value::Boolean(_) => Type::Boolean,
479			Value::Float4(_) => Type::Float4,
480			Value::Float8(_) => Type::Float8,
481			Value::Int1(_) => Type::Int1,
482			Value::Int2(_) => Type::Int2,
483			Value::Int4(_) => Type::Int4,
484			Value::Int8(_) => Type::Int8,
485			Value::Int16(_) => Type::Int16,
486			Value::Utf8(_) => Type::Utf8,
487			Value::Uint1(_) => Type::Uint1,
488			Value::Uint2(_) => Type::Uint2,
489			Value::Uint4(_) => Type::Uint4,
490			Value::Uint8(_) => Type::Uint8,
491			Value::Uint16(_) => Type::Uint16,
492			Value::Date(_) => Type::Date,
493			Value::DateTime(_) => Type::DateTime,
494			Value::Time(_) => Type::Time,
495			Value::Duration(_) => Type::Duration,
496			Value::IdentityId(_) => Type::IdentityId,
497			Value::Uuid4(_) => Type::Uuid4,
498			Value::Uuid7(_) => Type::Uuid7,
499			Value::Blob(_) => Type::Blob,
500			Value::Int(_) => Type::Int,
501			Value::Uint(_) => Type::Uint,
502			Value::Decimal(_) => Type::Decimal,
503			Value::Any(_) => Type::Any,
504			Value::DictionaryId(_) => Type::DictionaryId,
505			Value::Type(t) => t.clone(),
506		}
507	}
508}