Enum spacetimedb_table::layout::AlgebraicTypeLayout

source ·

pub enum AlgebraicTypeLayout {
    Sum(SumTypeLayout),
    Product(ProductTypeLayout),
    Primitive(PrimitiveType),
    VarLen(VarLenType),
}

Expand description

Mostly a mirror of AlgebraicType annotated with a Layout.

Notable differences from AlgebraicType:

Refs are not supported. Supporting recursive types remains a TODO(future-work). Note that the previous Spacetime datastore did not support recursive types in tables.
BuiltinType is separated into [PrimitveType] (atomically-sized types like integers) and VarLenType (strings, arrays, and maps). This separation allows cleaner pattern-matching, e.g. in HasLayout::layout, where VarLenType returns a static ref to [VAR_LEN_REF_LAYOUT], and PrimitiveType dispatches on its variant to return a static ref to a type-specific Layout.

Variants§

§

Sum(SumTypeLayout)

A sum type, annotated with its layout.

§

Product(ProductTypeLayout)

A product type, annotated with its layout.

§

Primitive(PrimitiveType)

A primitive type, annotated with its layout.

§

VarLen(VarLenType)

A variable length type, annotated with its layout.

Implementations§

source §

impl AlgebraicTypeLayout

source

pub fn is_sum(&self) -> bool

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

source

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

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

source

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

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

source

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

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

source

pub fn is_product(&self) -> bool

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

source

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

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

source

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

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

source

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

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

source

pub fn is_primitive(&self) -> bool

Returns true if this is a AlgebraicTypeLayout::Primitive, otherwise false

source

pub fn as_primitive_mut(&mut self) -> Option<&mut PrimitiveType>

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

source

pub fn as_primitive(&self) -> Option<&PrimitiveType>

Optionally returns references to the inner fields if this is a AlgebraicTypeLayout::Primitive, otherwise None

source

pub fn into_primitive(self) -> Result<PrimitiveType, Self>

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

source

pub fn is_var_len(&self) -> bool

Returns true if this is a AlgebraicTypeLayout::VarLen, otherwise false

source

pub fn as_var_len_mut(&mut self) -> Option<&mut VarLenType>

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

source

pub fn as_var_len(&self) -> Option<&VarLenType>

Optionally returns references to the inner fields if this is a AlgebraicTypeLayout::VarLen, otherwise None

source

pub fn into_var_len(self) -> Result<VarLenType, Self>

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

source §

pub fn algebraic_type(&self) -> AlgebraicType

Convert an AlgebraicTypeLayout back into an AlgebraicType, removing layout information.

This operation is O(n) in the number of nodes in the argument, and may heap-allocate. It is intended for use in error paths, where performance is a secondary concern.