Module spacetimedb_table::layout

Defines Layout, which encompasses the fixed size and alignment of an object, e.g., a row, or a column, or some other sub-division of a row.

Layout annotated versions of SATS types are also provided, such as ProductTypeLayout and AlgebraicTypeLayout. These, and others, determine what the layout of objects typed at those types are. They also implement HasLayout which generalizes over layout annotated types.

Structs

• Layout
  The layout of a fixed object or the layout that fixed objects of a type will have.
• ProductTypeElementLayout
  A mirrior of ProductTypeElement annotated with a Layout.
• ProductTypeLayout
  A mirror of ProductType annotated with a Layout.
• RowTypeLayout
  The type of a row, annotated with a Layout.
• SumTypeLayout
  A mirrior of SumType annotated with a Layout.
• SumTypeVariantLayout
  A mirrior of SumTypeVariant annotated with a Layout.

Enums

• AlgebraicTypeLayout
  Mostly a mirror of AlgebraicType annotated with a Layout.
• PrimitiveType
  Variants of BuiltinType which do not require a VarLenRef indirection, i.e. bools, integers and floats.
• VarLenType
  BuiltinType variants which require a VarLenRef indirection, i.e. strings, arrays and maps.

Constants

• MIN_ROW_ALIGN
  Fixed-length row portions must also be sufficiently aligned to store a FreeCellRef.
• MIN_ROW_SIZE
  Fixed-length row portions must be at least large enough to store a FreeCellRef.

Traits

• HasLayout
  A type which knows what its layout is.

Functions

• align_to
  Aligns a base offset to the required_alignment and returns it.
• bsatn_len
  Computes the size of val when BSATN encoding without actually encoding.
• required_var_len_granules_for_row
  Counts the number of VarLenGranule allocations required to store val in a page.
• row_size_for_bytes
  Returns the minimum row size needed to store required_bytes accounting for the minimum row size and alignment.
• row_size_for_type
  Returns the minimum row size needed to store a T, accounting for the minimum row size and alignment.