idanarye/rust-typed-builder
Rust Typed Builder
This library provides a procedural macro utility for Rust that automates the implementation of type-safe builder patterns. By leveraging the compiler to enforce structural integrity, it ensures that all mandatory fields are initialized and that objects are constructed in a valid state before the program executes.
The project distinguishes itself by using typestate-based tracking and marker types to encode the initialization progress of an object directly into the type system. This approach allows for a zero-cost abstraction layer where all validation logic and state checks are resolved during compilation, eliminating the need for runtime checks or memory overhead.
The builder generation logic supports a wide range of configuration options, including custom default values, optional field handling, and setter input transformations. It enables the creation of fluent, chainable interfaces that simplify the initialization of complex data structures while maintaining strict compile-time data validation.
The library is distributed as a derive macro, allowing developers to integrate builder functionality into custom data structures through standard attribute-based annotations.
Features
- Type-Safe Configuration Builders - Generates type-safe builder patterns that enforce mandatory field assignment and prevent duplicate assignments at compile time.
- Type-Safe Query Construction - Ensures all mandatory struct fields are assigned at compile time to prevent runtime initialization errors.
- Build-Time Validation - Enforces strict data integrity rules during the object building process to guarantee valid states.
- Typestate Trackers - Encodes initialization progress into the type system to prevent incomplete object construction.
- Procedural Macros - Automates the generation of builder structs and methods at compile time using procedural macros.
- Builder Libraries - Generates type-safe builder patterns for structs at compile time to ensure all mandatory fields are initialized.
- Required Field Enforcement - Validates that all mandatory fields are assigned during construction to prevent runtime errors.
- Automatic Trait Conversions - Automatically transforms setter arguments into required field types using generic trait bounds.
- Phantom Data Patterns - Uses zero-sized marker types to track builder state at compile time without adding runtime memory overhead.
- Struct Initializer Patterns - Simplifies complex object creation through automated default values, optional fields, and input conversions.
- Object Field Optionality - Enables marking specific fields as optional to allow omission during object construction.
- Schema Default Values - Assigns custom default values to fields for automatic population during construction.
- Zero-Overhead Abstractions - Resolves all builder logic and type checks during compilation to eliminate runtime overhead.
- Compile-Time Type Validation - Validates struct construction logic during compilation to enforce data integrity.
- Fluent Builder APIs - Provides ergonomic, chainable builder interfaces for configuring complex data structures.
