reifydb_macro/lib.rs
1// Copyright (c) reifydb.com 2025
2// This file is licensed under the MIT, see license.md file
3
4//! Derive macros for ReifyDB.
5//!
6//! This crate provides the `#[derive(FromFrame)]` macro for ergonomic
7//! deserialization of Frame data into Rust structs.
8//!
9//! # Example
10
11#![cfg_attr(not(debug_assertions), deny(warnings))]
12//! ```ignore
13//! use reifydb_type::FromFrame;
14//!
15//! #[derive(FromFrame)]
16//! struct User {
17//! id: i64,
18//! name: String,
19//! #[frame(column = "created_at")]
20//! timestamp: i64,
21//! #[frame(optional)]
22//! email: Option<String>,
23//! }
24//!
25//! let users: Vec<User> = frame.try_into()?;
26//! ```
27
28use proc_macro::TokenStream;
29
30/// Derives `FromFrame` for a struct, enabling deserialization from a Frame.
31///
32/// This derive generates code that references types from `reifydb_type`.
33/// For code that references `reifydb` or `reifydb_client`, use the
34/// `FromFrame` derive from those crates instead.
35///
36/// # Attributes
37///
38/// - `#[frame(column = "name")]` - Use a different column name than the field name
39/// - `#[frame(optional)]` - Field is optional; missing columns or Undefined values become None
40/// - `#[frame(coerce)]` - Use widening type coercion for this field
41/// - `#[frame(skip)]` - Skip this field (must implement Default)
42#[proc_macro_derive(FromFrame, attributes(frame))]
43pub fn derive_from_frame(input: TokenStream) -> TokenStream {
44 reifydb_macro_impl::derive_from_frame_with_crate(input.into(), "reifydb_type").into()
45}