1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
// =============================================================================
// Copyright (c) 2025 - 2026 Haixing Hu.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0.
// =============================================================================
//! # Value Processing Framework
//!
//! Provides type-safe value storage and access functionality, supporting single
//! values, collections, explicit scalar-or-collection shape, and named values.
//!
//! # Public API Overview
//!
//! - [`Value`] stores one typed scalar, including an explicit `Unset(DataType)`
//! state.
//! - [`MultiValues`] stores one homogeneous typed collection.
//! - [`ValueRef`] and [`MultiValuesRef`] expose borrowed semantic views while
//! keeping runtime storage private.
//! - [`ValueContainer`] preserves whether storage is scalar or collection.
//! - [`NamedValue`] and [`NamedMultiValues`] provide name wrappers.
//! - [`ValueWireV1`] and [`ValueWirePayloadV1`] name explicit Serde DTOs.
//! - [`ValueWireRefV1`] and [`ValueWirePayloadRefV1`] serialize borrowed
//! values.
//!
//! # Core behavior
//!
//! - [`Value::get`] and [`MultiValues::get`] perform strict typed reads.
//! - [`ValueContainer`] preserves whether the source supplied a scalar or an
//! explicit collection, even when the collection contains one item.
//! - `to` methods use `qubit-datatype` conversion policy and resource limits.
//! - Optional type families and conversion methods are available only when the
//! corresponding crate features are enabled; all-features documentation shows
//! the superset of those APIs.
//! - [`Value::is_unset`] and [`ValueContainer::is_unset`] indicate that no
//! concrete value is stored.
//! - [`MultiValues::is_unset`] distinguishes no collection from a concrete
//! collection; [`MultiValues::is_empty`] reports only that its length is
//! zero.
//! - Generic `set` replaces a value infallibly; [`MultiValues::add`] remains
//! fallible because appended values must have the same data type.
//! - Serde uses the strict, type-preserving [`ValueWireV1`] envelope. Its
//! canonical JSON representation is byte-stable for the same value under the
//! supported `serde_json` version and configuration. String-map keys and
//! nested JSON object keys are emitted in lexicographic order. Other Serde
//! formats are supported as representations, but are outside this byte-level
//! stability contract. With the `natural-json` feature, `to_json_value`
//! provides a separate natural JSON projection with the same ordering.
//! - Version one rejects externally tagged representations.
//! - Non-finite floats may exist in memory, but V1 Serde and natural JSON
//! reject them because JSON has no `NaN` or infinity number literals.
//! - JSON numbers follow `qubit-json`'s explicit range contract: negative
//! integers fit `i64`, non-negative integers fit `u64`, and fractional or
//! exponential values are finite `f64`. Wider exact values use the crate's
//! explicit string-based integer and decimal wire representations.
//!
//! # Usage Examples
//!
//! ## Single Value Operations
//!
//! ```rust
//! use qubit_value::Value;
//!
//! // Create and access a single value
//! let value = Value::Int32(42);
//! assert_eq!(value.get_int32().unwrap(), 42);
//!
//! // Strict generic access
//! let number: i32 = value.get().unwrap();
//! assert_eq!(number, 42);
//! ```
//!
//! ## Multiple Values Operations
//!
//! ```rust
//! use qubit_value::MultiValues;
//!
//! // Create and access multiple values
//! let mut values = MultiValues::Int32(vec![1, 2, 3]);
//! assert_eq!(values.len(), 3);
//!
//! // Add values
//! values.add(4).unwrap();
//! assert_eq!(values.get_int32s().unwrap(), &[1, 2, 3, 4]);
//! ```
//!
//! ## Named Value Operations
//!
//! ```rust
//! use qubit_value::{NamedValue, Value};
//!
//! // Create a named value
//! let config = NamedValue::new("port", Value::Int32(8080));
//! assert_eq!(config.name(), "port");
//! assert_eq!(config.value().get_int32().unwrap(), 8080);
//! ```
//!
//! ## Explicit Shape Operations
//!
//! ```rust
//! use qubit_value::ValueContainer;
//!
//! let scalar = ValueContainer::from(42_i32);
//! let collection = ValueContainer::from(vec![42_i32]);
//! assert!(scalar.is_scalar());
//! assert!(collection.is_collection());
//! ```
// Sub-modules
// Public exports
pub use IntoValueDefault;
pub use MultiValues;
pub use MultiValuesRef;
pub use NamedMultiValues;
pub use NamedValue;
pub use NumericComparisonError;
pub use StrictValueRead;
pub use Value;
pub use ValueRef;
pub use ValueContainer;
pub use ValueError;
pub use ValueResult;
pub use ValueMissing;
pub use ValueMissingReason;
pub use ValueWireDecodeError;
pub use ValueWireEncodeError;
pub use ValueWireEncodePreflight;
pub use ValueWirePayloadRefV1;
pub use ValueWirePayloadV1;
pub use ValueWirePayloadV1Seed;
pub use ValueWireRefV1;
pub use ValueWireV1;
pub use ValueWireV1Seed;