sequential_gen 0.1.2

//! # Sequential ID Generator
//!
//! This crate provides a simple sequential ID generator that can be used to generate unique sequential IDs.
//! The generator allows you to specify the step to increment the value by. To use the generator, you need to
//! ensure that only one instance of the generator is created. This can be achieved by using a singleton pattern
//! or by using a global variable.
//!
//! The crate provides a `Generator` trait that you can implement to create your own generator. The crate also
//! provides a `SimpleGenerator` that you can use out of the box.
//!
//! The crate is `no_std` compatible. To use the crate in a `no_std` environment, you need to disable the default
//! features and enable the `no_std` feature in your `Cargo.toml`.
//!
//! ```toml
//! [dependencies]
//! sequential-gen = { version = "0.1", default-features = false, features = ["no_std"] }
//! ```
//!
//! ## Usage
//!
//! ```rust
//! # extern crate lazy_static;
//!
//! # use lazy_static::lazy_static;
//! use sequential_gen::prelude::*;
//!
//! lazy_static! {
//!    static ref GENERATOR: SimpleGenerator<u128> = SimpleGenerator::new(1u128);
//! }
//!
//! fn main() {
//!   let id = GENERATOR.generate();
//!   // Use your ID
//! }
//! ```
//!
//! ## Features
//! The following features are available:
//! - `default`: Enables the standard library.
//! - `no_std`: Disables the standard library.
//! - `uuid`: Enables support for generating UUIDs. This feature is not available in a `no_std` environment.

#![cfg_attr(feature = "no_std", no_std)]

#[cfg(all(feature = "no_std", feature = "uuid"))]
compile_error!("Cannot enable both `no_std` and `uuid` features at the same time.");

mod lib {
	pub use self::core::clone::Clone;
	pub use self::core::convert::{From, Into};
	pub use self::core::default::Default;
	pub use self::core::fmt::Debug;
	pub use self::core::marker::Copy;
	pub use self::core::ops::Add;
	pub use self::core::sync::atomic::{AtomicUsize, Ordering};
	pub use self::core::usize;

	mod core {
		#[cfg(feature = "no_std")]
		pub use core::*;
		#[cfg(not(feature = "no_std"))]
		pub use std::*;
	}
}

mod generator;

pub mod prelude {
	pub use crate::generator::{Generator, simple::SimpleGenerator};
	#[cfg(not(feature = "no_std"))]
		pub use crate::generator::unix_epoch::EpochBasedGenerator;
	#[cfg(feature = "uuid")]
	pub use crate::generator::uuid::UuidGenerator;
}