Struct Generator 

pub struct Generator { /* private fields */ }

Configure code generation, then choose one explicit schema source.

Custom Rust syntax is checked before writing output. Generated structs preserve SQL names with Serde attributes. Additional derives and attributes apply to data types, not markers.

Implementations

impl Generator

pub fn new() -> Self

pub fn schemas( self, schemas: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Replace the default public selection with these schemas.

pub fn schema(self, schema: impl Into<String>) -> Self

Select a single schema instead of the default public.

pub fn prelude(self, prelude: impl Into<String>) -> Self

Add Rust items or imports before the generated schema modules.

pub fn derive(self, derive: impl Into<String>) -> Self

Add a derive path, such as ::typed_builder::TypedBuilder.

pub fn attribute(self, attribute: impl Into<String>) -> Self

Add an outer attribute, including its #[...] delimiters.

pub fn type_attribute( self, generated_type: impl Into<String>, attribute: impl Into<String>, ) -> Self

Add an attribute to one generated data type.

Paths use generated Rust names, for example public.tables.messages.Insert. Unknown paths fail generation instead of silently ignoring customization.

pub fn type_override( self, postgres_type: impl Into<String>, rust_type: impl Into<String>, ) -> Self

Map a qualified SQL type to a Rust type that matches the PostgREST JSON representation.

pub fn runtime_path(self, path: impl Into<String>) -> Self

Set the runtime module path when the client dependency has a Cargo alias.

pub fn not_null( self, target: impl Into<String>, fields: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Assert non-null fields on a view Row, composite, or RPC Record. Unknown targets and SQL field names fail generation.

pub fn column_type( self, target: impl Into<String>, rust_type: impl Into<String>, ) -> Self

Override one SQL column’s base type, preserving nullability and omission. Accepts public.table.column or public.tables.table.column.

pub fn json_type( self, target: impl Into<String>, rust_type: impl Into<String>, ) -> Self

Decode a JSON field, RPC argument or return using a custom Serde type. SQL arrays, nullability, and set-returning wrappers remain intact.

pub const fn reexport_macros(self) -> Self

Export crate-local select! and key! wrappers with the runtime path filled. Include the generated bindings at the schema crate’s root.

pub fn relationship_alias( self, target: impl Into<String>, alias: impl Into<String>, ) -> Self

Add an alias for one canonical qualified relationship marker. For example public.tables.orders.relationships.orders_customer_fkey.

pub const fn strict_args(self) -> Self

Require non-default RPC inputs unless explicitly marked nullable.

pub fn strict_args_for(self, target: impl Into<String>) -> Self

Apply strict RPC input contracts to one generated function module.

pub fn from_snapshot(self, path: impl AsRef<Path>) -> Result<Bindings, Error>

Load a portable snapshot and register Cargo’s file change detection.

Errors

Fails for unreadable, invalid, or unsupported-version snapshots.

pub fn from_metadata(self, snapshot: Snapshot) -> Result<Bindings, Error>

Generate from in-memory metadata. Does not emit Cargo change instructions.

Errors

Fails for unsupported versions, invalid metadata, or invalid custom Rust syntax.

Trait Implementations

impl Clone for Generator

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Generator

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

Formats the value using the given formatter.

impl Default for Generator

fn default() -> Self

Returns the “default value” for a type.