Enum spacetimedb_sats::algebraic_value::AlgebraicValue

pub enum AlgebraicValue {
    Sum(SumValue),
    Product(ProductValue),
    Array(ArrayValue),
    Map(MapValue),
    Bool(bool),
    I8(i8),
    U8(u8),
    I16(i16),
    U16(u16),
    I32(i32),
    U32(u32),
    I64(i64),
    U64(u64),
    I128(i128),
    U128(u128),
    F32(F32),
    F64(F64),
    String(String),
}

A value in SATS typed at some AlgebraicType.

Values are type erased, so they do not store their type. This is important mainly for space efficiency, including network latency and bandwidth.

These are only values and not expressions. That is, they are canonical and cannot be simplified further by some evaluation. So forms like 42 + 24 are not represented in an AlgebraicValue.

Variants

Sum(SumValue)

A structural sum value.

Given a sum type { N_0(T_0), N_1(T_1), ..., N_n(T_n) } where N_i denotes a variant name and where T_i denotes the type the variant stores, a sum value makes a specific choice as to the variant. So for example, we might chose N_1(T_1) and represent this choice with (1, v) where v is a value of type T_1.

Product(ProductValue)

A structural product value.

Given a product type { N_0: T_0, N_1: T_1, ..., N_n: T_n } where N_i denotes a field / element name and where T_i denotes the type the field stores, a product value stores a value v_i of type T_i for each field N_i.

Array(ArrayValue)

A homogeneous array of AlgebraicValues. The array has the type [AlgebraicType::Array(elem_ty)].

The contained values are stored packed in a representation appropriate for their type. See ArrayValue for details on the representation.

Map(MapValue)

An ordered map value of key: AlgebraicValues mapped to value: AlgebraicValues. Each key must be of the same AlgebraicType as all the others and the same applies to each value. A map as a whole has the type [AlgebraicType::Map(key_ty, val_ty)].

Maps are implemented internally as [BTreeMap<AlgebraicValue, AlgebraicValue>]. This implies that key/values are ordered first by key and then value as if they were a sorted slice [(key, value)]. This order is observable as maps are exposed both directly and indirectly via Ord for AlgebraicValue. The latter lets us observe that e.g., { a: 42 } < { b: 42 }. However, we cannot observe any difference between { a: 0, b: 0 } and { b: 0, a: 0 }, as the natural order is used as opposed to insertion order. Where insertion order is relevant, a AlgebraicValue::Array with (key, value) pairs can be used instead.

We box the MapValue to reduce size and because we assume that map values will be uncommon.

Bool(bool)

A bool value of type AlgebraicType::Bool.

I8(i8)

An i8 value of type AlgebraicType::I8.

U8(u8)

A u8 value of type AlgebraicType::U8.

I16(i16)

An i16 value of type AlgebraicType::I16.

U16(u16)

A u16 value of type AlgebraicType::U16.

I32(i32)

An i32 value of type AlgebraicType::I32.

U32(u32)

A u32 value of type AlgebraicType::U32.

I64(i64)

An i64 value of type AlgebraicType::I64.

U64(u64)

A u64 value of type AlgebraicType::U64.

I128(i128)

An i128 value of type AlgebraicType::I128.

We box these up as they allow us to shrink AlgebraicValue.

U128(u128)

A u128 value of type AlgebraicType::U128.

We box these up as they allow us to shrink AlgebraicValue.

F32(F32)

A totally ordered F32 value of type AlgebraicType::F32.

All floating point values defined in IEEE-754 are supported. However, unlike the primitive f32, a total order is established.

F64(F64)

A totally ordered F64 value of type AlgebraicType::F64.

All floating point values defined in IEEE-754 are supported. However, unlike the primitive f64, a total order is established.

String(String)

A UTF-8 string value of type AlgebraicType::String.

Uses Rust’s standard representation of strings.

Implementations

impl AlgebraicValue

pub fn is_sum(&self) -> bool

Returns true if this is a AlgebraicValue::Sum, otherwise false

pub fn as_sum_mut(&mut self) -> Option<&mut SumValue>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::Sum, otherwise None

pub fn as_sum(&self) -> Option<&SumValue>

Optionally returns references to the inner fields if this is a AlgebraicValue::Sum, otherwise None

pub fn into_sum(self) -> Result<SumValue, Self>

Returns the inner fields if this is a AlgebraicValue::Sum, otherwise returns back the enum in the Err case of the result

pub fn is_product(&self) -> bool

Returns true if this is a AlgebraicValue::Product, otherwise false

pub fn as_product_mut(&mut self) -> Option<&mut ProductValue>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::Product, otherwise None

pub fn as_product(&self) -> Option<&ProductValue>

Optionally returns references to the inner fields if this is a AlgebraicValue::Product, otherwise None

pub fn into_product(self) -> Result<ProductValue, Self>

Returns the inner fields if this is a AlgebraicValue::Product, otherwise returns back the enum in the Err case of the result

pub fn is_array(&self) -> bool

Returns true if this is a AlgebraicValue::Array, otherwise false

pub fn as_array_mut(&mut self) -> Option<&mut ArrayValue>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::Array, otherwise None

pub fn as_array(&self) -> Option<&ArrayValue>

Optionally returns references to the inner fields if this is a AlgebraicValue::Array, otherwise None

pub fn into_array(self) -> Result<ArrayValue, Self>

Returns the inner fields if this is a AlgebraicValue::Array, otherwise returns back the enum in the Err case of the result

pub fn is_map(&self) -> bool

Returns true if this is a AlgebraicValue::Map, otherwise false

pub fn as_map_mut(&mut self) -> Option<&mut MapValue>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::Map, otherwise None

pub fn as_map(&self) -> Option<&MapValue>

Optionally returns references to the inner fields if this is a AlgebraicValue::Map, otherwise None

pub fn into_map(self) -> Result<MapValue, Self>

Returns the inner fields if this is a AlgebraicValue::Map, otherwise returns back the enum in the Err case of the result

pub fn is_bool(&self) -> bool

Returns true if this is a AlgebraicValue::Bool, otherwise false

pub fn as_bool_mut(&mut self) -> Option<&mut bool>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::Bool, otherwise None

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

Optionally returns references to the inner fields if this is a AlgebraicValue::Bool, otherwise None

pub fn into_bool(self) -> Result<bool, Self>

Returns the inner fields if this is a AlgebraicValue::Bool, otherwise returns back the enum in the Err case of the result

pub fn is_i8(&self) -> bool

Returns true if this is a AlgebraicValue::I8, otherwise false

pub fn as_i8_mut(&mut self) -> Option<&mut i8>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::I8, otherwise None

pub fn as_i8(&self) -> Option<&i8>

Optionally returns references to the inner fields if this is a AlgebraicValue::I8, otherwise None

pub fn into_i8(self) -> Result<i8, Self>

Returns the inner fields if this is a AlgebraicValue::I8, otherwise returns back the enum in the Err case of the result

pub fn is_u8(&self) -> bool

Returns true if this is a AlgebraicValue::U8, otherwise false

pub fn as_u8_mut(&mut self) -> Option<&mut u8>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::U8, otherwise None

pub fn as_u8(&self) -> Option<&u8>

Optionally returns references to the inner fields if this is a AlgebraicValue::U8, otherwise None

pub fn into_u8(self) -> Result<u8, Self>

Returns the inner fields if this is a AlgebraicValue::U8, otherwise returns back the enum in the Err case of the result

pub fn is_i16(&self) -> bool

Returns true if this is a AlgebraicValue::I16, otherwise false

pub fn as_i16_mut(&mut self) -> Option<&mut i16>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::I16, otherwise None

pub fn as_i16(&self) -> Option<&i16>

Optionally returns references to the inner fields if this is a AlgebraicValue::I16, otherwise None

pub fn into_i16(self) -> Result<i16, Self>

Returns the inner fields if this is a AlgebraicValue::I16, otherwise returns back the enum in the Err case of the result

pub fn is_u16(&self) -> bool

Returns true if this is a AlgebraicValue::U16, otherwise false

pub fn as_u16_mut(&mut self) -> Option<&mut u16>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::U16, otherwise None

pub fn as_u16(&self) -> Option<&u16>

Optionally returns references to the inner fields if this is a AlgebraicValue::U16, otherwise None

pub fn into_u16(self) -> Result<u16, Self>

Returns the inner fields if this is a AlgebraicValue::U16, otherwise returns back the enum in the Err case of the result

pub fn is_i32(&self) -> bool

Returns true if this is a AlgebraicValue::I32, otherwise false

pub fn as_i32_mut(&mut self) -> Option<&mut i32>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::I32, otherwise None

pub fn as_i32(&self) -> Option<&i32>

Optionally returns references to the inner fields if this is a AlgebraicValue::I32, otherwise None

pub fn into_i32(self) -> Result<i32, Self>

Returns the inner fields if this is a AlgebraicValue::I32, otherwise returns back the enum in the Err case of the result

pub fn is_u32(&self) -> bool

Returns true if this is a AlgebraicValue::U32, otherwise false

pub fn as_u32_mut(&mut self) -> Option<&mut u32>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::U32, otherwise None

pub fn as_u32(&self) -> Option<&u32>

Optionally returns references to the inner fields if this is a AlgebraicValue::U32, otherwise None

pub fn into_u32(self) -> Result<u32, Self>

Returns the inner fields if this is a AlgebraicValue::U32, otherwise returns back the enum in the Err case of the result

pub fn is_i64(&self) -> bool

Returns true if this is a AlgebraicValue::I64, otherwise false

pub fn as_i64_mut(&mut self) -> Option<&mut i64>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::I64, otherwise None

pub fn as_i64(&self) -> Option<&i64>

Optionally returns references to the inner fields if this is a AlgebraicValue::I64, otherwise None

pub fn into_i64(self) -> Result<i64, Self>

Returns the inner fields if this is a AlgebraicValue::I64, otherwise returns back the enum in the Err case of the result

pub fn is_u64(&self) -> bool

Returns true if this is a AlgebraicValue::U64, otherwise false

pub fn as_u64_mut(&mut self) -> Option<&mut u64>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::U64, otherwise None

pub fn as_u64(&self) -> Option<&u64>

Optionally returns references to the inner fields if this is a AlgebraicValue::U64, otherwise None

pub fn into_u64(self) -> Result<u64, Self>

Returns the inner fields if this is a AlgebraicValue::U64, otherwise returns back the enum in the Err case of the result

pub fn is_i128(&self) -> bool

Returns true if this is a AlgebraicValue::I128, otherwise false

pub fn as_i128_mut(&mut self) -> Option<&mut i128>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::I128, otherwise None

pub fn as_i128(&self) -> Option<&i128>

Optionally returns references to the inner fields if this is a AlgebraicValue::I128, otherwise None

pub fn into_i128(self) -> Result<i128, Self>

Returns the inner fields if this is a AlgebraicValue::I128, otherwise returns back the enum in the Err case of the result

pub fn is_u128(&self) -> bool

Returns true if this is a AlgebraicValue::U128, otherwise false

pub fn as_u128_mut(&mut self) -> Option<&mut u128>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::U128, otherwise None

pub fn as_u128(&self) -> Option<&u128>

Optionally returns references to the inner fields if this is a AlgebraicValue::U128, otherwise None

pub fn into_u128(self) -> Result<u128, Self>

Returns the inner fields if this is a AlgebraicValue::U128, otherwise returns back the enum in the Err case of the result

pub fn is_f32(&self) -> bool

Returns true if this is a AlgebraicValue::F32, otherwise false

pub fn as_f32_mut(&mut self) -> Option<&mut F32>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::F32, otherwise None

pub fn as_f32(&self) -> Option<&F32>

Optionally returns references to the inner fields if this is a AlgebraicValue::F32, otherwise None

pub fn into_f32(self) -> Result<F32, Self>

Returns the inner fields if this is a AlgebraicValue::F32, otherwise returns back the enum in the Err case of the result

pub fn is_f64(&self) -> bool

Returns true if this is a AlgebraicValue::F64, otherwise false

pub fn as_f64_mut(&mut self) -> Option<&mut F64>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::F64, otherwise None

pub fn as_f64(&self) -> Option<&F64>

Optionally returns references to the inner fields if this is a AlgebraicValue::F64, otherwise None

pub fn into_f64(self) -> Result<F64, Self>

Returns the inner fields if this is a AlgebraicValue::F64, otherwise returns back the enum in the Err case of the result

pub fn is_string(&self) -> bool

Returns true if this is a AlgebraicValue::String, otherwise false

pub fn as_string_mut(&mut self) -> Option<&mut String>

Optionally returns mutable references to the inner fields if this is a AlgebraicValue::String, otherwise None

pub fn as_string(&self) -> Option<&String>

Optionally returns references to the inner fields if this is a AlgebraicValue::String, otherwise None

pub fn into_string(self) -> Result<String, Self>

Returns the inner fields if this is a AlgebraicValue::String, otherwise returns back the enum in the Err case of the result

impl AlgebraicValue

pub fn as_bytes(&self) -> Option<&[u8]>

Interpret the value as a byte slice or None if it isn’t a byte slice.

pub fn unit() -> Self

The canonical unit value defined as the nullary product value ().

The type of UNIT is ().

pub const fn Bytes(v: Vec<u8>) -> Self

Returns an AlgebraicValue representing v: Vec<u8>.

pub fn into_bytes(self) -> Result<Vec<u8>, Self>

Converts self into a byte string, if applicable.

pub fn OptionSome(v: Self) -> Self

Returns an AlgebraicValue for some: v.

The some variant is assigned the tag 0.

pub fn OptionNone() -> Self

Returns an AlgebraicValue for none.

The none variant is assigned the tag 1.

pub fn sum(tag: u8, value: Self) -> Self

Returns an AlgebraicValue representing a sum value with tag and value.

pub const fn product(elements: Vec<Self>) -> Self

Returns an AlgebraicValue representing a product value with the given elements.

pub fn map(map: MapValue) -> Self

Returns an AlgebraicValue representing a map value defined by the given map.

pub fn type_of(&self) -> AlgebraicType

Infer the AlgebraicType of an AlgebraicValue.

pub fn is_numeric_zero(&self) -> bool

Returns whether this value represents a numeric zero.

Can only be true where the type is numeric.

pub fn from_sequence_value(ty: &AlgebraicType, sequence_value: i128) -> Self

Converts sequence_value to an appropriate AlgebraicValue based on ty. Truncates the sequence_value to fit ty.

Panics if ty is not an integer type.

impl AlgebraicValue

pub fn decode<'a>( ty: &<Self as Value>::Type, bytes: &mut impl BufReader<'a> ) -> Result<Self, DecodeError>

Decode a value from bytes typed at ty.

pub fn decode_smallvec<'a>( ty: &<Self as Value>::Type, bytes: &mut impl BufReader<'a> ) -> Result<SmallVec<[Self; 1]>, DecodeError>

Decode a vector of values from bytes with each value typed at ty.

pub fn encode(&self, bytes: &mut impl BufWriter)

Trait Implementations

impl Clone for AlgebraicValue

fn clone(&self) -> AlgebraicValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AlgebraicValue

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

Formats the value using the given formatter.

impl From<&[u8]> for AlgebraicValue

fn from(x: &[u8]) -> Self

Converts to this type from the input type.

impl From<&AlgebraicValue> for ProductValue

fn from(x: &AlgebraicValue) -> Self

Converts to this type from the input type.

impl From<&str> for AlgebraicValue

fn from(x: &str) -> Self

Converts to this type from the input type.

impl From<AlgebraicValue> for FieldExpr

fn from(original: AlgebraicValue) -> FieldExpr

Converts to this type from the input type.

impl From<AlgebraicValue> for ProductValue

fn from(x: AlgebraicValue) -> Self

Converts to this type from the input type.

impl From<AlgebraicValue> for ValueDeserializer

fn from(original: AlgebraicValue) -> ValueDeserializer

Converts to this type from the input type.

impl From<ArrayValue> for AlgebraicValue

fn from(original: ArrayValue) -> AlgebraicValue

Converts to this type from the input type.

impl From<BTreeMap<AlgebraicValue, AlgebraicValue>> for AlgebraicValue

fn from(original: MapValue) -> AlgebraicValue

Converts to this type from the input type.

impl From<ColId> for AlgebraicValue

fn from(value: ColId) -> Self

Converts to this type from the input type.

impl From<ConstrainedFloat<f32, UnitConstraint<f32>>> for AlgebraicValue

fn from(original: F32) -> AlgebraicValue

Converts to this type from the input type.

impl From<ConstrainedFloat<f64, UnitConstraint<f64>>> for AlgebraicValue

fn from(original: F64) -> AlgebraicValue

Converts to this type from the input type.

impl From<ConstraintId> for AlgebraicValue

fn from(value: ConstraintId) -> Self

Converts to this type from the input type.

impl From<IndexId> for AlgebraicValue

fn from(value: IndexId) -> Self

Converts to this type from the input type.

impl<T: Into<AlgebraicValue>> From<Option<T>> for AlgebraicValue

fn from(value: Option<T>) -> Self

Converts to this type from the input type.

impl From<ProductValue> for AlgebraicValue

fn from(original: ProductValue) -> AlgebraicValue

Converts to this type from the input type.

impl From<SequenceId> for AlgebraicValue

fn from(value: SequenceId) -> Self

Converts to this type from the input type.

impl From<String> for AlgebraicValue

fn from(original: String) -> AlgebraicValue

Converts to this type from the input type.

impl From<SumValue> for AlgebraicValue

fn from(original: SumValue) -> AlgebraicValue

Converts to this type from the input type.

impl From<TableId> for AlgebraicValue

fn from(value: TableId) -> Self

Converts to this type from the input type.

impl From<bool> for AlgebraicValue

fn from(original: bool) -> AlgebraicValue

Converts to this type from the input type.

impl From<f32> for AlgebraicValue

fn from(x: f32) -> Self

Converts to this type from the input type.

impl From<f64> for AlgebraicValue

fn from(x: f64) -> Self

Converts to this type from the input type.

impl From<i128> for AlgebraicValue

fn from(original: i128) -> AlgebraicValue

Converts to this type from the input type.

impl From<i16> for AlgebraicValue

fn from(original: i16) -> AlgebraicValue

Converts to this type from the input type.

impl From<i32> for AlgebraicValue

fn from(original: i32) -> AlgebraicValue

Converts to this type from the input type.

impl From<i64> for AlgebraicValue

fn from(original: i64) -> AlgebraicValue

Converts to this type from the input type.

impl From<i8> for AlgebraicValue

fn from(original: i8) -> AlgebraicValue

Converts to this type from the input type.

impl From<u128> for AlgebraicValue

fn from(original: u128) -> AlgebraicValue

Converts to this type from the input type.

impl From<u16> for AlgebraicValue

fn from(original: u16) -> AlgebraicValue

Converts to this type from the input type.

impl From<u32> for AlgebraicValue

fn from(original: u32) -> AlgebraicValue

Converts to this type from the input type.

impl From<u64> for AlgebraicValue

fn from(original: u64) -> AlgebraicValue

Converts to this type from the input type.

impl From<u8> for AlgebraicValue

fn from(original: u8) -> AlgebraicValue

Converts to this type from the input type.

impl FromIterator<AlgebraicValue> for ProductValue

fn from_iter<T: IntoIterator<Item = AlgebraicValue>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for AlgebraicValue

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AlgebraicValue

fn cmp(&self, other: &AlgebraicValue) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for AlgebraicValue

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for AlgebraicValue

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl RangeBounds<AlgebraicValue> for AlgebraicValue

fn start_bound(&self) -> Bound<&AlgebraicValue>

Start index bound.

fn end_bound(&self) -> Bound<&AlgebraicValue>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

impl Serialize for AlgebraicValue

fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error>

Serialize self in the data format of S using the provided serializer.

impl ToDataKey for AlgebraicValue

fn to_data_key(&self) -> DataKey

impl Value for AlgebraicValue

type Type = AlgebraicType

The type of this value.

impl Eq for AlgebraicValue

impl StructuralPartialEq for AlgebraicValue