Enum Value 

pub enum Value {
    Account(Account),
    Blob(Vec<u8>),
    Bool(bool),
    Date(Date),
    Decimal(Decimal),
    Duration(Duration),
    Enum(ValueEnum),
    Float32(Float32),
    Float64(Float64),
    Int(i64),
    Int128(Int128),
    IntBig(Int),
    List(Vec<Self>),
    Map(Vec<(Self, Self)>),
    Null,
    Principal(Principal),
    Subaccount(Subaccount),
    Text(String),
    Timestamp(Timestamp),
    Uint(u64),
    Uint128(Nat128),
    UintBig(Nat),
    Ulid(Ulid),
    Unit,
}

Variants

Account(Account)

Blob(Vec<u8>)

Bool(bool)

Date(Date)

Decimal(Decimal)

Duration(Duration)

Enum(ValueEnum)

Float32(Float32)

Float64(Float64)

Int(i64)

Int128(Int128)

IntBig(Int)

List(Vec<Self>)

Ordered list of values. Used for many-cardinality transport. List order is preserved for normalization and fingerprints.

Map(Vec<(Self, Self)>)

Canonical deterministic map representation.

• Maps are unordered values; insertion order is discarded.
• Entries are always sorted by canonical key order and keys are unique.
• Map fields remain non-queryable and persist as atomic value replacements.
• Persistence treats map fields as atomic value replacements per row save.

Null

Principal(Principal)

Subaccount(Subaccount)

Text(String)

Timestamp(Timestamp)

Uint(u64)

Uint128(Nat128)

UintBig(Nat)

Ulid(Ulid)

Unit

Implementations

impl Value

pub fn validate_map_entries( entries: &[(Self, Self)], ) -> Result<(), MapValueError>

Validate map entry invariants without changing order.

pub fn normalize_map_entries( entries: Vec<(Self, Self)>, ) -> Result<Vec<(Self, Self)>, MapValueError>

Normalize map entries into canonical deterministic order.

impl Value

pub const fn is_empty(&self) -> Option<bool>

pub fn is_not_empty(&self) -> Option<bool>

Logical negation of is_empty.

pub fn contains(&self, needle: &Self) -> Option<bool>

Returns true if self contains needle (or equals it for scalars).

pub fn contains_any(&self, needles: &Self) -> Option<bool>

Returns true if any item in needles matches a member of self.

pub fn contains_all(&self, needles: &Self) -> Option<bool>

Returns true if every item in needles matches a member of self.

pub fn in_list(&self, haystack: &Self) -> Option<bool>

Returns true if self exists inside the provided list.

pub fn contains_ci(&self, needle: &Self) -> Option<bool>

Case-insensitive contains supporting text and identifier variants.

pub fn contains_any_ci(&self, needles: &Self) -> Option<bool>

Case-insensitive variant of contains_any.

pub fn contains_all_ci(&self, needles: &Self) -> Option<bool>

Case-insensitive variant of contains_all.

pub fn in_list_ci(&self, haystack: &Self) -> Option<bool>

Case-insensitive variant of in_list.

impl Value

pub fn cmp_numeric(&self, other: &Self) -> Option<Ordering>

Compare two runtime values under value-local numeric coercion semantics.

Database execution code should use db::numeric helpers as the canonical runtime boundary; this method remains the representation-local comparison primitive that those higher-level helpers are tested against.

impl Value

pub fn text_eq(&self, other: &Self, mode: TextMode) -> Option<bool>

Case-sensitive/insensitive equality check for text-like values.

pub fn text_contains(&self, needle: &Self, mode: TextMode) -> Option<bool>

Check whether other is a substring of self under the given text mode.

pub fn text_starts_with(&self, needle: &Self, mode: TextMode) -> Option<bool>

Check whether self starts with other under the given text mode.

pub fn text_ends_with(&self, needle: &Self, mode: TextMode) -> Option<bool>

Check whether self ends with other under the given text mode.

impl Value

pub const fn is_numeric(&self) -> bool

Returns true if the value is one of the numeric-like variants supported by numeric comparison/ordering.

pub const fn supports_numeric_coercion(&self) -> bool

Returns true when numeric coercion/comparison is explicitly allowed.

impl Value

pub const __KIND: FieldKind

pub const __STORAGE_DECODE: FieldStorageDecode = FieldStorageDecode::Value

impl Value

pub fn from_slice<T>(items: &[T]) -> Self

where T: Into<Self> + Clone,

CONSTRUCTION

Build a Value::List from a list literal.

Intended for tests and inline construction. Requires Clone because items are borrowed.

pub fn from_list<T>(items: Vec<T>) -> Self

where T: Into<Self>,

Build a Value::List from owned items.

This is the canonical constructor for query / DTO boundaries.

pub fn from_map(entries: Vec<(Self, Self)>) -> Result<Self, MapValueError>

Build a canonical Value::Map from owned key/value entries.

Invariants are validated and entries are normalized:

• keys must be scalar and non-null
• values may be scalar or structured
• entries are sorted by canonical key order
• duplicate keys are rejected

pub fn from_enum<E: EnumValue>(value: E) -> Self

Build a Value::Enum from a domain enum using its explicit mapping.

pub fn enum_strict<E: Path>(variant: &str) -> Self

Build a strict enum value using the canonical path of E.

pub const fn is_text(&self) -> bool

TYPES

Returns true if the value is Text.

pub const fn is_unit(&self) -> bool

Returns true if the value is Unit (used for presence/null comparators).

pub const fn is_scalar(&self) -> bool

pub fn canonical_cmp_key(left: &Self, right: &Self) -> Ordering

Total canonical comparator used for map-key normalization.

pub const fn as_storage_key(&self) -> Option<StorageKey>

CONVERSION

NOTE: Unit is intentionally treated as a valid storage key and indexable, used for singleton tables and synthetic identity entities. Only Null is non-indexable.

pub const fn as_text(&self) -> Option<&str>

pub const fn as_list(&self) -> Option<&[Self]>

pub const fn as_map(&self) -> Option<&[(Self, Self)]>

Trait Implementations

impl CandidType for Value

fn _ty() -> Type

fn _ty_doc() -> TypeDoc

fn id() -> TypeId

fn idl_serialize<__S>(&self, __serializer: __S) -> Result<(), __S::Error>

where __S: Serializer,

fn ty() -> Type

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CoercionFamilyExt for Value

fn coercion_family(&self) -> CoercionFamily

Returns the coercion-routing family for this value.

NOTE: This does NOT imply numeric, arithmetic, ordering, or keyability support. All scalar capabilities are registry-driven.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Value

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FieldTypeMeta for Value

const KIND: FieldKind

Semantic field kind used for runtime planning and validation.

const STORAGE_DECODE: FieldStorageDecode = FieldStorageDecode::Value

Persisted decode contract used by row and payload decoding.

const NESTED_FIELDS: &'static [FieldModel] = _

Known nested fields for generated structured records.

impl<E> From<&Id<E>> for Value

where E: EntityKey,

fn from(id: &Id<E>) -> Self

Converts to this type from the input type.

impl From<&InputValue> for Value

fn from(value: &InputValue) -> Self

Converts to this type from the input type.

impl From<&Value> for InputValue

fn from(value: &Value) -> Self

Converts to this type from the input type.

impl From<&Value> for OutputValue

fn from(value: &Value) -> Self

Converts to this type from the input type.

impl From<&str> for Value

fn from(v: &str) -> Self

Converts to this type from the input type.

impl From<()> for Value

fn from((): ()) -> Self

Converts to this type from the input type.

impl From<Account> for Value

fn from(v: Account) -> Self

Converts to this type from the input type.

impl From<Date> for Value

fn from(v: Date) -> Self

Converts to this type from the input type.

impl From<Decimal> for Value

fn from(v: Decimal) -> Self

Converts to this type from the input type.

impl From<Duration> for Value

fn from(v: Duration) -> Self

Converts to this type from the input type.

impl<E> From<Id<E>> for Value

where E: EntityKey,

fn from(id: Id<E>) -> Self

Converts to this type from the input type.

impl From<InputValue> for Value

fn from(value: InputValue) -> Self

Converts to this type from the input type.

impl From<Int> for Value

fn from(v: Int) -> Self

Converts to this type from the input type.

impl From<Nat> for Value

fn from(v: Nat) -> Self

Converts to this type from the input type.

impl From<Principal> for Value

fn from(v: Principal) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(v: String) -> Self

Converts to this type from the input type.

impl From<Subaccount> for Value

fn from(v: Subaccount) -> Self

Converts to this type from the input type.

impl From<Timestamp> for Value

fn from(v: Timestamp) -> Self

Converts to this type from the input type.

impl From<Ulid> for Value

fn from(v: Ulid) -> Self

Converts to this type from the input type.

impl From<Value> for InputValue

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<Value> for OutputValue

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<Vec<Value>> for Value

fn from(vec: Vec<Self>) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(v: bool) -> Self

Converts to this type from the input type.

impl From<i128> for Value

fn from(v: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Value

fn from(v: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(v: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Value

fn from(v: i8) -> Self

Converts to this type from the input type.

impl From<u128> for Value

fn from(v: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Value

fn from(v: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Value

fn from(v: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Value

fn from(v: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Value

fn from(v: u8) -> Self

Converts to this type from the input type.

impl PartialEq for Value

fn eq(&self, other: &Value) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Value

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl PersistedStructuredFieldCodec for Value

fn encode_persisted_structured_payload(&self) -> Result<Vec<u8>, InternalError>

Encode this typed structured field into persisted custom payload bytes.

fn decode_persisted_structured_payload( bytes: &[u8], ) -> Result<Self, InternalError>

Decode this typed structured field from persisted custom payload bytes.

impl RuntimeValueDecode for Value

fn from_value(value: &Value) -> Option<Self>

impl RuntimeValueEncode for Value

fn to_value(&self) -> Value

impl RuntimeValueMeta for Value

fn kind() -> RuntimeValueKind

impl TryFrom<Vec<(Value, Value)>> for Value

type Error = SchemaInvariantError

The type returned in the event of a conversion error.

fn try_from(entries: Vec<(Self, Self)>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Value

impl StructuralPartialEq for Value