entity-derive-impl 0.3.0

Internal proc-macro implementation for entity-derive. Use entity-derive instead.
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

// SPDX-FileCopyrightText: 2025-2026 RAprogramm <andrey.rozanov.vl@gmail.com>
// SPDX-License-Identifier: MIT

//! UUID version configuration for ID generation.
//!
//! This module defines [`UuidVersion`], which controls which UUID version
//! is used for auto-generated primary keys.

use darling::FromMeta;

/// UUID version for ID generation.
///
/// Controls which UUID version is used for auto-generated primary keys.
///
/// # Variants
///
/// | Version | Method | Properties |
/// |---------|--------|------------|
/// | `V7` | `Uuid::now_v7()` | Time-ordered, sortable, default |
/// | `V4` | `Uuid::new_v4()` | Random, widely compatible |
///
/// # Examples
///
/// ```rust,ignore
/// // UUIDv7 (default) - time-ordered, best for databases
/// #[entity(table = "users")]
/// #[entity(table = "users", uuid = "v7")]
///
/// // UUIDv4 - random, for compatibility
/// #[entity(table = "users", uuid = "v4")]
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum UuidVersion {
    /// UUID version 7 - time-ordered.
    ///
    /// Uses `Uuid::now_v7()`. Recommended for database primary keys
    /// as it provides natural ordering by creation time.
    #[default]
    V7,

    /// UUID version 4 - random.
    ///
    /// Uses `Uuid::new_v4()`. Classic random UUID, widely supported.
    V4
}

impl FromMeta for UuidVersion {
    /// Parse UUID version from string attribute value.
    ///
    /// # Accepted Values
    ///
    /// - `"v7"`, `"7"` → [`UuidVersion::V7`]
    /// - `"v4"`, `"4"` → [`UuidVersion::V4`]
    ///
    /// Values are case-insensitive.
    ///
    /// # Errors
    ///
    /// Returns `darling::Error::unknown_value` for unrecognized values.
    fn from_string(value: &str) -> darling::Result<Self> {
        match value.to_lowercase().as_str() {
            "v7" | "7" => Ok(UuidVersion::V7),
            "v4" | "4" => Ok(UuidVersion::V4),
            _ => Err(darling::Error::unknown_value(value))
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn default_is_v7() {
        assert_eq!(UuidVersion::default(), UuidVersion::V7);
    }

    #[test]
    fn from_meta_v7() {
        assert_eq!(UuidVersion::from_string("v7").unwrap(), UuidVersion::V7);
        assert_eq!(UuidVersion::from_string("7").unwrap(), UuidVersion::V7);
        assert_eq!(UuidVersion::from_string("V7").unwrap(), UuidVersion::V7);
    }

    #[test]
    fn from_meta_v4() {
        assert_eq!(UuidVersion::from_string("v4").unwrap(), UuidVersion::V4);
        assert_eq!(UuidVersion::from_string("4").unwrap(), UuidVersion::V4);
        assert_eq!(UuidVersion::from_string("V4").unwrap(), UuidVersion::V4);
    }

    #[test]
    fn from_meta_invalid() {
        assert!(UuidVersion::from_string("v1").is_err());
        assert!(UuidVersion::from_string("v5").is_err());
        assert!(UuidVersion::from_string("uuid7").is_err());
    }
}