Module spacetimedb_table::page

Provides a Page abstraction that stores rows and an associated header necessary for the page to work. Consult the documentation of this type for a list of operations and a description of how page work.

A page can provide a split mutable view of its fixed section and its variable section. This is provided through Page::split_fixed_var_mut with view operations defined on FixedView and VarView.

Technical terms:

• valid refers to, when referring to a type, granule, or row, depending on the context, a memory location that holds a safe object. When “valid for writes” is used, it refers to the MaybeUninit case.

  See the post [Two Kinds of Invariants: Safety and Validity][ralf_safe_valid] for a discussion on safety and validity invariants.

Structs

• FixedLenRowsIter
  An iterator over the PageOffsets of all present fixed-length rows in a Page.
• FixedView
  A mutable view of the fixed-len section of a Page.
• GranuleOffsetIter
  An iterator yielding the offsets to the granules of a var-len object.
• Page
  A page of row data with an associated header and the raw row_data itself.
• VarView
  A mutable view of the var-len section of a Page.

Enums

• Error

Functions

• get_ref^⚠
  Returns a reference to the [T] pointed to at by offset.