Struct RawModuleDefV9 

pub struct RawModuleDefV9 {
    pub typespace: Typespace,
    pub tables: Vec<RawTableDefV9>,
    pub reducers: Vec<RawReducerDefV9>,
    pub types: Vec<RawTypeDefV9>,
    pub misc_exports: Vec<RawMiscModuleExportV9>,
    pub row_level_security: Vec<RawRowLevelSecurityDefV9>,
}

A possibly-invalid raw module definition.

ABI Version 9.

These “raw definitions” may contain invalid data, and are validated by the validate module into a proper spacetimedb_schema::ModuleDef, or a collection of errors.

The module definition has a single logical global namespace, which maps Identifiers to:

• database-level objects:
  • logical schema objects:
    • tables
    • constraints
    • sequence definitions
  • physical schema objects:
    • indexes
• module-level objects:
  • reducers
  • schedule definitions
• binding-level objects:
  • type aliases

All of these types of objects must have unique names within the module. The exception is columns, which need unique names only within a table.

Fields

typespace: Typespace

The Typespace used by the module.

AlgebraicTypeRefs in the table, reducer, and type alias declarations refer to this typespace.

The typespace must satisfy Typespace::is_valid_for_client_code_generation. That is, all types stored in the typespace must either:

1. satisfy AlgebraicType::is_valid_for_client_type_definition
2. and/or AlgebraicType::is_valid_for_client_type_use.

Types satisfying condition 1 correspond to generated classes in client code. (Types satisfying condition 2 are an artifact of the module bindings, and do not affect the semantics of the module definition.)

Types satisfying condition 1 are required to have corresponding RawTypeDefV9 declarations in the module.

tables: Vec<RawTableDefV9>

The tables of the database definition used in the module.

Each table must have a unique name.

reducers: Vec<RawReducerDefV9>

The reducers exported by the module.

types: Vec<RawTypeDefV9>

The types exported by the module.

misc_exports: Vec<RawMiscModuleExportV9>

Miscellaneous additional module exports.

row_level_security: Vec<RawRowLevelSecurityDefV9>

Low level security definitions.

Each definition must have a unique name.

Trait Implementations

impl Clone for RawModuleDefV9

fn clone(&self) -> RawModuleDefV9

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RawModuleDefV9

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

Formats the value using the given formatter.

impl Default for RawModuleDefV9

fn default() -> RawModuleDefV9

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RawModuleDefV9

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

Deserialize this value from the given deserializer.

impl Serialize for RawModuleDefV9

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

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

impl SpacetimeType for RawModuleDefV9

fn make_type<S: TypespaceBuilder>(__typespace: &mut S) -> AlgebraicType

Returns an AlgebraicType representing the type for Self in SATS and in the typing context in typespace. This is used by the automatic type registration system in Rust modules.