Enum spacetimedb_lib::AlgebraicValue

pub enum AlgebraicValue {
    Sum(SumValue),
    Product(ProductValue),
    Builtin(BuiltinValue),
}

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.

Builtin(BuiltinValue)

A builtin value that has a builtin type.

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, AlgebraicValue>

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, AlgebraicValue>

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_builtin(&self) -> bool

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

pub fn as_builtin_mut(&mut self) -> Option<&mut BuiltinValue>

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

pub fn as_builtin(&self) -> Option<&BuiltinValue>

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

pub fn into_builtin(self) -> Result<BuiltinValue, AlgebraicValue>

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

impl AlgebraicValue

pub const UNIT: AlgebraicValue = Self::product(Vec::new())

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

The type of UNIT is ().

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

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

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

Interpret the value as an i8 or None if it isn’t a i8 value.

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

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

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

Interpret the value as an i16 or None if it isn’t an i16 value.

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

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

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

Interpret the value as an i32 or None if it isn’t an i32 value.

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

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

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

Interpret the value as an i64 or None if it isn’t an i64 value.

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

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

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

Interpret the value as an i128 or None if it isn’t an i128 value.

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

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

pub fn as_f32(&self) -> Option<&ConstrainedFloat<f32, UnitConstraint<f32>>>

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

pub fn as_f64(&self) -> Option<&ConstrainedFloat<f64, UnitConstraint<f64>>>

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

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

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

pub fn as_bytes(&self) -> Option<&Vec<u8, Global>>

Interpret the value as a Vec<u8> or None if it isn’t a Vec<u8> value.

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

Interpret the value as an ArrayValue or None if it isn’t an ArrayValue value.

pub fn as_map( &self ) -> Option<&BTreeMap<AlgebraicValue, AlgebraicValue, Global>>

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

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

Convert the value into a bool or Err(self) if it isn’t a bool value.

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

Convert the value into an i8 or Err(self) if it isn’t an i8 value.

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

Convert the value into a u8 or Err(self) if it isn’t a u8 value.

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

Convert the value into an i16 or Err(self) if it isn’t an i16 value.

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

Convert the value into a u16 or Err(self) if it isn’t a u16 value.

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

Convert the value into an i32 or Err(self) if it isn’t an i32 value.

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

Convert the value into a u32 or Err(self) if it isn’t a u32 value.

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

Convert the value into an i64 or Err(self) if it isn’t an i64 value.

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

Convert the value into a u64 or Err(self) if it isn’t a u64 value.

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

Convert the value into an i128 or Err(self) if it isn’t an i128 value.

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

Convert the value into a u128 or Err(self) if it isn’t a u128 value.

pub fn into_f32( self ) -> Result<ConstrainedFloat<f32, UnitConstraint<f32>>, AlgebraicValue>

Convert the value into a f32 or Err(self) if it isn’t a f32 value.

pub fn into_f64( self ) -> Result<ConstrainedFloat<f64, UnitConstraint<f64>>, AlgebraicValue>

Convert the value into a f64 or Err(self) if it isn’t a f64 value.

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

Convert the value into a String or Err(self) if it isn’t a String value.

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

Convert the value into a Vec<u8> or Err(self) if it isn’t a Vec<u8> value.

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

Convert the value into an ArrayValue or Err(self) if it isn’t an ArrayValue value.

pub fn into_map( self ) -> Result<BTreeMap<AlgebraicValue, AlgebraicValue, Global>, AlgebraicValue>

Convert the value into a map or Err(self) if it isn’t a map value.

pub const fn Bool(v: bool) -> AlgebraicValue

Returns an AlgebraicValue representing v: bool.

pub const fn I8(v: i8) -> AlgebraicValue

Returns an AlgebraicValue representing v: i8.

pub const fn U8(v: u8) -> AlgebraicValue

Returns an AlgebraicValue representing v: u8.

pub const fn I16(v: i16) -> AlgebraicValue

Returns an AlgebraicValue representing v: i16.

pub const fn U16(v: u16) -> AlgebraicValue

Returns an AlgebraicValue representing v: u16.

pub const fn I32(v: i32) -> AlgebraicValue

Returns an AlgebraicValue representing v: i32.

pub const fn U32(v: u32) -> AlgebraicValue

Returns an AlgebraicValue representing v: u32.

pub const fn I64(v: i64) -> AlgebraicValue

Returns an AlgebraicValue representing v: i64.

pub const fn U64(v: u64) -> AlgebraicValue

Returns an AlgebraicValue representing v: u64.

pub const fn I128(v: i128) -> AlgebraicValue

Returns an AlgebraicValue representing v: i128.

pub const fn U128(v: u128) -> AlgebraicValue

Returns an AlgebraicValue representing v: u128.

pub const fn F32( v: ConstrainedFloat<f32, UnitConstraint<f32>> ) -> AlgebraicValue

Returns an AlgebraicValue representing v: f32.

pub const fn F64( v: ConstrainedFloat<f64, UnitConstraint<f64>> ) -> AlgebraicValue

Returns an AlgebraicValue representing v: f64.

pub const fn String(v: String) -> AlgebraicValue

Returns an AlgebraicValue representing v: String.

pub const fn Bytes(v: Vec<u8, Global>) -> AlgebraicValue

Returns an AlgebraicValue representing v: Vec<u8>.

pub fn ArrayOf(val: impl Into<ArrayValue>) -> AlgebraicValue

Returns an AlgebraicValue for a val which can be converted into an ArrayValue.

pub fn OptionSome(v: AlgebraicValue) -> AlgebraicValue

Returns an AlgebraicValue for some: v.

The some variant is assigned the tag 0.

pub fn OptionNone() -> AlgebraicValue

Returns an AlgebraicValue for none.

The none variant is assigned the tag 1.

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

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

pub const fn product(elements: Vec<AlgebraicValue, Global>) -> AlgebraicValue

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

pub const fn map( map: BTreeMap<AlgebraicValue, AlgebraicValue, Global> ) -> AlgebraicValue

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

pub fn type_of(&self) -> AlgebraicType

Infer the AlgebraicType of an AlgebraicValue.

impl AlgebraicValue

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

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<(), Error>

Formats the value using the given formatter.

impl From<&[u8]> for AlgebraicValue

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

Converts to this type from the input type.

impl From<&AlgebraicValue> for ProductValue

fn from(x: &AlgebraicValue) -> ProductValue

Converts to this type from the input type.

impl From<&str> for AlgebraicValue

fn from(x: &str) -> AlgebraicValue

Converts to this type from the input type.

impl From<AlgebraicValue> for FieldExpr

fn from(x: AlgebraicValue) -> Self

Converts to this type from the input type.

impl From<AlgebraicValue> for ProductValue

fn from(x: AlgebraicValue) -> ProductValue

Converts to this type from the input type.

impl From<BuiltinValue> for AlgebraicValue

fn from(value: BuiltinValue) -> AlgebraicValue

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<ProductValue> for AlgebraicValue

fn from(x: ProductValue) -> AlgebraicValue

Converts to this type from the input type.

impl From<String> for AlgebraicValue

fn from(x: String) -> AlgebraicValue

Converts to this type from the input type.

impl From<bool> for AlgebraicValue

fn from(x: bool) -> AlgebraicValue

Converts to this type from the input type.

impl From<f32> for AlgebraicValue

fn from(x: f32) -> AlgebraicValue

Converts to this type from the input type.

impl From<f64> for AlgebraicValue

fn from(x: f64) -> AlgebraicValue

Converts to this type from the input type.

impl From<i128> for AlgebraicValue

fn from(x: i128) -> AlgebraicValue

Converts to this type from the input type.

impl From<i16> for AlgebraicValue

fn from(x: i16) -> AlgebraicValue

Converts to this type from the input type.

impl From<i32> for AlgebraicValue

fn from(x: i32) -> AlgebraicValue

Converts to this type from the input type.

impl From<i64> for AlgebraicValue

fn from(x: i64) -> AlgebraicValue

Converts to this type from the input type.

impl From<i8> for AlgebraicValue

fn from(x: i8) -> AlgebraicValue

Converts to this type from the input type.

impl From<u128> for AlgebraicValue

fn from(x: u128) -> AlgebraicValue

Converts to this type from the input type.

impl From<u16> for AlgebraicValue

fn from(x: u16) -> AlgebraicValue

Converts to this type from the input type.

impl From<u32> for AlgebraicValue

fn from(x: u32) -> AlgebraicValue

Converts to this type from the input type.

impl From<u64> for AlgebraicValue

fn from(x: u64) -> AlgebraicValue

Converts to this type from the input type.

impl From<u8> for AlgebraicValue

fn from(x: u8) -> AlgebraicValue

Converts to this type from the input type.

impl FromIterator<AlgebraicValue> for ProductValue

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

Creates a value from an iterator.

impl Hash for AlgebraicValue

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

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) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<AlgebraicValue> 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<AlgebraicValue> 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 Serialize for AlgebraicValue

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

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

impl Serialize for AlgebraicValue

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

Serialize this value into the given Serde 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 StructuralEq for AlgebraicValue

impl StructuralPartialEq for AlgebraicValue