API Reference rustq v#0.6.0

Copy Markdown View Source

Modules

Rust template quasiquoting and code generation.

Helpers for discovering Rust package metadata through Cargo.

Decoded subset of cargo metadata used by RustQ.

Package entry from cargo metadata.

DSL for declaring generated RustQ files in rustq.exs.

File sync helpers for RustQ-generated sources.

Valid-Elixir macro frontend for generating RustQ Rust fragments.

Structural metadata for an Elixir typespec lowered by RustQ.

Resolved metadata for a RustQ.NativeRef.

Resolved metadata for a native Rust enum.

Reference to a Rust native item used by code generators.

Elixir-friendly builders for Rust fragments.

Small Rust AST/IR used by macro frontends before final RustQ validation.

Small builder DSL for RustQ.Rust.AST nodes.

Small constructor API for RustQ pattern AST nodes.

Small constructor API for RustQ type AST nodes.

Represents a Rust const declaration built with RustQ.Rust.const/4.

Represents a Rust enum declaration built with RustQ.Rust.enum/2.

Represents a Rust struct field built with RustQ.Rust.field/3.

Represents a raw Rust fragment validated or spliced by RustQ.

Represents a Rust function declaration built with RustQ.Rust.fn/2.

Represents a Rust impl block built with RustQ.Rust.impl/2.

Represents a Rust module declaration built with RustQ.Rust.mod/2.

Represents a Rust struct declaration built with RustQ.Rust.struct/2.

Represents a Rust type alias built with RustQ.Rust.type_alias/3.

Represents a Rust use declaration built with RustQ.Rust.use/2.

Builders for common Rustler NIF code.

Schema DSL for generating Rustler structs and tagged enums.

Provides the ~R sigil for inline Rust templates.

Public helpers for lowering Elixir typespec forms into RustQ type metadata.

Helpers for composing RustQ splice replacements as plain keyword lists.

Structural metadata for Rust source parsed with syn.

Rust function or method argument metadata. type is rendered Rust; type_ast is structured metadata.

Utilities for rendering Rust doc comments for downstream docs.

Rust enum metadata, including doc comments and variant names.

Rust struct field metadata.

Rust source file metadata.

Rust free function metadata, including doc comments, arguments, and return type.

Rust impl block metadata, including target type, optional trait, doc comments, and methods.

In-memory index of Rust source metadata parsed by RustQ.Syn.

Rust impl method metadata, including doc comments, arguments, and return type.

Receiver method call metadata found in Rust source.

Structured Rust function or method signature metadata.

Rust struct metadata.

Namespace for structured Rust type metadata.

Rust array type metadata.

Rust impl Trait type metadata.

Rust Option<T> type metadata.

Rust path type metadata, for example Paint, skia_safe::Canvas, or AsRef<Rect>.

Fallback Rust type metadata for type forms RustQ does not model structurally yet.

Rust reference type metadata, for example &Paint or &mut Path.

Rust Result<T, E> type metadata.

Rust Self type metadata.

Rust slice type metadata.

Rust tuple type metadata.

Rust type alias metadata.

Rust use item metadata, including reexport aliases.

Parsed Rust template plus pending substitutions.

Built-in Rust/Rustler type vocabulary for RustQ.Meta.defrust/2 specs.

Mix Tasks

Generates files declared in rustq.exs.