Enum Error 

pub enum Error {
    IdSegInvalid,
    EpochInvalid,
    SequenceInvalid,
    TimestampMaxReached,
    SequenceMaxReached(Duration),
    TimestampError,
    MutexError,
    InvalidId,
    TooManySegments,
}

possible errors for Snowclouds/Snowflakes

since the errors are not very complex no additional information is provided except for SequenceMaxReached that provides the duration to the next millisecond.

this error implements NextAvailId if being used in a generic way.

use snowcloud::Error::SequenceMaxReached;
type MyFlake = snowcloud::i64::SingleIdFlake<43, 8, 12>;
type MyCloud = snowcloud::Generator<MyFlake>;

const START_TIME: u64 = 1679587200000;

let mut cloud = MyCloud::new(START_TIME, 1)
    .expect("failed to create MyCloud");

match cloud.next_id() {
    Ok(flake) => {
        println!("{}", flake.id());
    },
    Err(err) => {
        match err {
            SequenceMaxReached(dur) => {
                // we can wait for the specified duration to try again
            },
            _ => {
                println!("{}", err);
            }
        }
    }
}

Variants

IdSegInvalid

a provided id seg is invalid.

EpochInvalid

a provided epoch is invalid

SequenceInvalid

a provided sequence is less than 0 or greater than the max value specified by a Snowflake

TimestampMaxReached

the max possible timestamp value has been reached when generating a new id

SequenceMaxReached(Duration)

the max possible sequence value has been reached when generating a new id. the returned duration is an estimate on how long to wait for the next millisecond

TimestampError

failed to get a valid UNIX EPOCH timestamp

MutexError

error when attempting to lock a mutex

InvalidId

the provided i64 is not a valid Snowflake

TooManySegments

provided too many segments for creating a Snowflake

Trait Implementations

impl Debug for Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<SystemTimeError> for Error

fn from(_: SystemTimeError) -> Error

Converts to this type from the input type.

impl NextAvailId for Error

fn next_avail_id(&self) -> Option<&Duration>

optional return to get the duration to the next available id