tagid 1.2.0

Defines a newtype labeled tagging for different types of ids.
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

//! ID Generation Module
//!
//! This module defines the `IdGenerator` trait and provides implementations for generating unique
//! identifiers using different strategies, including CUID and UUID. The choice of ID generator
//! is controlled through feature flags (`cuid`, `ulid`, and `uuid`).

/// A trait for generating unique identifiers.
///
/// Implementations of this trait define how new unique IDs are created.
/// The associated type `IdType` represents the type of the generated ID.
///
/// # Example
/// ```rust
/// use tagid::IdGenerator;
///
/// struct MyIdGenerator;
///
/// impl IdGenerator for MyIdGenerator {
///     type IdType = u64;
///
///     fn next_id_rep() -> Self::IdType {
///         42 // Example static ID (replace with a real generator)
///     }
/// }
/// ```
pub trait IdGenerator {
    /// The type of the generated identifier.
    type IdType: Send;

    /// Generates and returns the next unique identifier.
    fn next_id_rep() -> Self::IdType;
}