Enum Value 

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

Value can be used in WHERE statements

None → the field’s value is Option::None (i.e., SQL NULL). Unit → internal placeholder for RHS; not a real value. Unsupported → the field exists but isn’t filterable/indexable.

Variants

Account(Account)

Blob(Vec<u8>)

Bool(bool)

Date(Date)

Decimal(Decimal)

Duration(Duration)

Enum(ValueEnum)

E8s(E8s)

E18s(E18s)

Float32(Float32)

Float64(Float64)

Int(i64)

Int128(Int128)

IntBig(Int)

List(Vec<Self>)

None

Principal(Principal)

Subaccount(Subaccount)

Text(String)

Timestamp(Timestamp)

Uint(u64)

Uint128(Nat128)

UintBig(Nat)

Ulid(Ulid)

Unit

Unsupported

Implementations

impl Value

pub const fn tag(&self) -> u8

HASHING

impl Value

pub fn hash_value(&self) -> [u8; 16]

Stable hash used for index/storage fingerprints.

impl Value

pub fn from_list<T: Into<Self> + Clone>(items: &[T]) -> Self

CONSTRUCTION

Build a Value::List from a slice of items convertible into Value.

pub const fn is_numeric(&self) -> bool

TYPES

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

pub const fn is_text(&self) -> bool

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 const fn as_key(&self) -> Option<Key>

CONVERSION

NOTE: Unit is intentionally treated as a valid key and indexable, used for tables with exactly one row or synthetic “single identity” entities. Only None and Unsupported are non-indexable.

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

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

pub fn to_index_fingerprint(&self) -> Option<[u8; 16]>

Stable 128-bit hash used for index keys; returns None for non-indexable values.

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

Cross-type numeric comparison; returns None if non-numeric.

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.

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

EMPTY

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

Logical negation of is_empty.

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

COLLECTIONS

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.

Trait Implementations

impl CandidType for Value

fn _ty() -> Type

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 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 FieldValue for Value

fn to_value(&self) -> Value

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 From<E18s> for Value

fn from(v: E18s) -> Self

Converts to this type from the input type.

impl From<E8s> for Value

fn from(v: E8s) -> 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<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 Serialize for Value

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ValueFamilyExt for Value

fn family(&self) -> ValueFamily

impl Eq for Value

impl StructuralPartialEq for Value