cuid2_timeless/
errors.rs

1use std::{error::Error, fmt::Display};
2
3#[derive(Clone, Copy, Debug)]
4/// List of possible errors (probably)
5/// ```
6/// let mut will_error = cuid2_timeless::cuid_wrapper();
7/// match will_error() {
8///     Ok(e) => {
9///         println!("{}", e);
10///     },
11///     Err(e) => {
12///         println!("oh no!");
13///     }
14/// }
15/// ```
16pub enum Errors {
17    /// [`crate::utils::create_entropy`] error for length less than 1
18    LessThanOneEntropyError,
19    /// [`crate::utils::base36_encode`] error for integer is negative (impossible)
20    CannotEncodeNegativeIntegersBase36EncodeError,
21    /// [`crate::Cuid::generate`] error for setting length longer than [`crate::generator::INITIAL_COUNT_MAX`]
22    ExceededMaximumLengthGenerateCuidError,
23}
24
25impl Error for Errors {}
26impl Display for Errors {
27    fn fmt(&self, _: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
28        Ok(())
29    }
30}