reifydb-client-derive 0.4.11

Derive macros for ReifyDB client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB
#![cfg_attr(not(debug_assertions), deny(clippy::disallowed_methods))]
#![cfg_attr(debug_assertions, warn(clippy::disallowed_methods))]
#![allow(clippy::tabs_in_doc_comments)]
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB
// This file is licensed under the MIT, see license.md file

//! Derive macros for ReifyDB client that generate code using `reifydb_client` crate paths.
//!
//! This crate is re-exported by the `reifydb-client` crate, so users typically don't
//! need to depend on it directly.

use proc_macro::TokenStream;
use reifydb_macro_impl::derive_from_frame_with_crate;

/// Derives `FromFrame` for a struct, enabling deserialization from a Frame.
///
/// Generated code references types from the `reifydb_client` crate.
///
/// # Attributes
///
/// - `#[frame(column = "name")]` - Use a different column name than the field name
/// - `#[frame(optional)]` - Field is optional; missing columns or None values become None
/// - `#[frame(coerce)]` - Use widening type coercion for this field
/// - `#[frame(skip)]` - Skip this field (must implement Default)
#[proc_macro_derive(FromFrame, attributes(frame))]
pub fn derive_from_frame(input: TokenStream) -> TokenStream {
	derive_from_frame_with_crate(input.into(), "reifydb_client").into()
}