entid 0.4.3

A library for generating and validating type-safe, prefixed entity identifiers based on UUIDs and ULIDs
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

/* Copyright © 2025, CosmicMind, Inc. */

use std::error::Error;
use std::fmt::{self, Display};

/// **Errors that can occur when working with entity IDs**
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum EntityIdError {
    /// The ID string doesn't have the expected format (prefix + delimiter + identifier)
    InvalidFormat,
    /// The identifier part of the ID string is not a valid identifier (UUID or ULID)
    InvalidIdentifier,
}

impl Display for EntityIdError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            EntityIdError::InvalidFormat => f.write_str("The provided ID has an invalid format"),
            EntityIdError::InvalidIdentifier => f.write_str("ID must contain a valid identifier"),
        }
    }
}

impl Error for EntityIdError {}

impl AsRef<str> for EntityIdError {
    fn as_ref(&self) -> &str {
        match self {
            EntityIdError::InvalidFormat => "The provided ID has an invalid format",
            EntityIdError::InvalidIdentifier => "ID must contain a valid identifier",
        }
    }
}

impl From<EntityIdError> for String {
    fn from(err: EntityIdError) -> Self {
        err.as_ref().to_string()
    }
}

impl From<&EntityIdError> for String {
    fn from(err: &EntityIdError) -> Self {
        err.as_ref().to_string()
    }
}

/// **Wrapper for identifier-specific errors**
#[derive(Debug)]
pub enum IdentifierError {
    /// Error from UUID operations
    Uuid(uuid::Error),
    /// Error from ULID operations
    Ulid(ulid::DecodeError),
}

impl Display for IdentifierError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            IdentifierError::Uuid(err) => write!(f, "Invalid UUID format: {}", err),
            IdentifierError::Ulid(err) => write!(f, "Invalid ULID format: {}", err),
        }
    }
}

impl Error for IdentifierError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            IdentifierError::Uuid(err) => Some(err),
            IdentifierError::Ulid(err) => Some(err),
        }
    }
}

impl From<uuid::Error> for IdentifierError {
    fn from(err: uuid::Error) -> Self {
        IdentifierError::Uuid(err)
    }
}

impl From<ulid::DecodeError> for IdentifierError {
    fn from(err: ulid::DecodeError) -> Self {
        IdentifierError::Ulid(err)
    }
}

impl From<IdentifierError> for String {
    fn from(err: IdentifierError) -> Self {
        match &err {
            IdentifierError::Uuid(uuid_err) => format!("Invalid UUID format: {}", uuid_err),
            IdentifierError::Ulid(ulid_err) => format!("Invalid ULID format: {}", ulid_err),
        }
    }
}

impl From<&IdentifierError> for String {
    fn from(err: &IdentifierError) -> Self {
        match err {
            IdentifierError::Uuid(uuid_err) => format!("Invalid UUID format: {}", uuid_err),
            IdentifierError::Ulid(ulid_err) => format!("Invalid ULID format: {}", ulid_err),
        }
    }
}

impl IdentifierError {
    /// Get the underlying UUID error, if this is a UUID error
    pub fn uuid_error(&self) -> Option<&uuid::Error> {
        match self {
            IdentifierError::Uuid(err) => Some(err),
            _ => None,
        }
    }

    /// Get the underlying ULID error, if this is a ULID error
    pub fn ulid_error(&self) -> Option<&ulid::DecodeError> {
        match self {
            IdentifierError::Ulid(err) => Some(err),
            _ => None,
        }
    }

    /// Get the error message from the underlying error
    pub fn error_message(&self) -> String {
        match self {
            IdentifierError::Uuid(err) => err.to_string(),
            IdentifierError::Ulid(err) => err.to_string(),
        }
    }
}