Enum spacetimedb_lib::type_def::TypeDef

pub enum TypeDef {
    Sum(SumType),
    Product(ProductType),
    Builtin(BuiltinType),
    Ref(AlgebraicTypeRef),
}

The SpacetimeDB Algebraic Type System (SATS) is a structural type system in which a nominal type system can be constructed.

The type system unifies the concepts sum types, product types, and built-in primitive types into a single type system.

Below are some common types you might implement in this type system.

type Unit = () // or (,) or , Product with zero elements
type Never = (|) // or | Sum with zero elements
type U8 = U8 // Builtin
type Foo = (foo: I8) != I8
type Bar = (bar: I8)
type Color = (a: I8 | b: I8) // Sum with one element
type Age = (age: U8) // Product with one element
type Option<T> = (some: T | none: ())
type Ref = &0

type AlgebraicType = (sum: SumType | product: ProductType | builtin: BuiltinType | set: AlgebraicType)
type Catalog<T> = (name: String, indices: Set<Set<Tag>>, relation: Set<>)
type CatalogEntry = { name: string, indexes: {some type}, relation: Relation }
type ElementValue = (tag: Tag, value: AlgebraicValue)
type AlgebraicValue = (sum: ElementValue | product: {ElementValue} | builtin: BuiltinValue | set: {AlgebraicValue})
type Any = (value: Bytes, type: AlgebraicType)

type Table<Row: ProductType> = (
    rows: Array<Row>
)

type HashSet<T> = (
    array: Array<T>
)

type BTreeSet<T> = (
    array: Array<T>
)

type TableType<Row: ProductType> = (
    relation: Table<Row>,
    indexes: Array<(index_type: String)>,
)

Variants

Sum(SumType)

Product(ProductType)

Builtin(BuiltinType)

Ref(AlgebraicTypeRef)

Implementations

impl AlgebraicType

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

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

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

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

pub fn into_sum(self) -> Result<SumType, AlgebraicType>

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

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

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

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

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

pub fn into_product(self) -> Result<ProductType, AlgebraicType>

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

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

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

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

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

pub fn into_builtin(self) -> Result<BuiltinType, AlgebraicType>

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

pub fn as_ref_mut(&mut self) -> Option<&mut AlgebraicTypeRef>

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

pub fn as_ref(&self) -> Option<&AlgebraicTypeRef>

Optionally returns references to the inner fields if this is a AlgebraicType::Ref, otherwise None

pub fn into_ref(self) -> Result<AlgebraicTypeRef, AlgebraicType>

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

impl AlgebraicType

pub const Bool: AlgebraicType = AlgebraicType::Builtin(BuiltinType::Bool)

pub const I8: AlgebraicType = AlgebraicType::Builtin(BuiltinType::I8)

pub const U8: AlgebraicType = AlgebraicType::Builtin(BuiltinType::U8)

pub const I16: AlgebraicType = AlgebraicType::Builtin(BuiltinType::I16)

pub const U16: AlgebraicType = AlgebraicType::Builtin(BuiltinType::U16)

pub const I32: AlgebraicType = AlgebraicType::Builtin(BuiltinType::I32)

pub const U32: AlgebraicType = AlgebraicType::Builtin(BuiltinType::U32)

pub const I64: AlgebraicType = AlgebraicType::Builtin(BuiltinType::I64)

pub const U64: AlgebraicType = AlgebraicType::Builtin(BuiltinType::U64)

pub const I128: AlgebraicType = AlgebraicType::Builtin(BuiltinType::I128)

pub const U128: AlgebraicType = AlgebraicType::Builtin(BuiltinType::U128)

pub const F32: AlgebraicType = AlgebraicType::Builtin(BuiltinType::F32)

pub const F64: AlgebraicType = AlgebraicType::Builtin(BuiltinType::F64)

pub const String: AlgebraicType = AlgebraicType::Builtin(BuiltinType::String)

pub fn bytes() -> AlgebraicType

impl AlgebraicType

pub fn make_meta_type() -> AlgebraicType

This is a static function that constructs the type of AlgebraicType and returns it as an AlgebraicType. This could alternatively be implemented as a regular AlgebraicValue or as a static variable.

pub fn make_never_type() -> AlgebraicType

pub const UNIT_TYPE: AlgebraicType = AlgebraicType::Product(ProductType{ elements: Vec::new(),})

pub fn make_option_type(some_type: AlgebraicType) -> AlgebraicType

pub fn as_value(&self) -> AlgebraicValue

pub fn from_value( value: &AlgebraicValue ) -> Result<AlgebraicType, ValueDeserializeError>

impl AlgebraicType

pub fn decode<'a>( bytes: &mut impl BufReader<'a> ) -> Result<AlgebraicType, DecodeError>

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

Trait Implementations

impl Clone for AlgebraicType

fn clone(&self) -> AlgebraicType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AlgebraicType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AlgebraicType

fn deserialize<D>( deserializer: D ) -> Result<AlgebraicType, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

impl<'de> Deserialize<'de> for AlgebraicType

fn deserialize<D>( deserializer: D ) -> Result<AlgebraicType, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for AlgebraicType

fn cmp(&self, other: &AlgebraicType) -> 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<AlgebraicType> for AlgebraicType

fn eq(&self, other: &AlgebraicType) -> 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<AlgebraicType> for AlgebraicType

fn partial_cmp(&self, other: &AlgebraicType) -> 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 AlgebraicType

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 Serialize for AlgebraicType

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

impl Eq for AlgebraicType

impl StructuralEq for AlgebraicType

impl StructuralPartialEq for AlgebraicType