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 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
use std::time::{Duration, SystemTime};
use std::fmt;
use crate::Ulid;
/// A Ulid generator that provides monotonically increasing Ulids
pub struct Generator {
previous: Ulid,
}
impl Generator {
/// Create a new ulid generator for monotonically ordered ulids
///
/// # Example
/// ```rust
/// use ulid::Generator;
///
/// let mut gen = Generator::new();
///
/// let ulid1 = gen.generate().unwrap();
/// let ulid2 = gen.generate().unwrap();
///
/// assert!(ulid1 < ulid2);
/// ```
pub fn new() -> Generator {
Generator {
previous: Ulid::nil(),
}
}
/// Generate a new Ulid. Each call is guaranteed to provide a Ulid with a larger value than the
/// last call. If the random bits would overflow, this method will return an error.
///
/// ```rust
/// use ulid::Generator;
/// let mut gen = Generator::new();
///
/// let ulid1 = gen.generate().unwrap();
/// let ulid2 = gen.generate().unwrap();
///
/// assert!(ulid1 < ulid2);
/// ```
pub fn generate(&mut self) -> Result<Ulid, MonotonicError> {
let now = SystemTime::now();
self.generate_from_datetime(now)
}
/// Generate a new Ulid matching the given DateTime.
/// Each call is guaranteed to provide a Ulid with a larger value than the last call.
/// If the random bits would overflow, this method will return an error.
///
/// # Example
/// ```rust
/// use ulid::Generator;
/// use std::time::SystemTime;
///
/// let dt = SystemTime::now();
/// let mut gen = Generator::new();
///
/// let ulid1 = gen.generate_from_datetime(dt).unwrap();
/// let ulid2 = gen.generate_from_datetime(dt).unwrap();
///
/// assert_eq!(ulid1.datetime(), ulid2.datetime());
/// assert!(ulid1 < ulid2);
/// ```
pub fn generate_from_datetime(&mut self, datetime: SystemTime) -> Result<Ulid, MonotonicError> {
self.generate_from_datetime_with_source(datetime, &mut rand::thread_rng())
}
/// Generate a new monotonic increasing Ulid with the given source
/// Each call is guaranteed to provide a Ulid with a larger value than the last call.
/// If the random bits would overflow, this method will return an error.
///
/// # Example
/// ```rust
/// use ulid::Generator;
/// use ulid::Ulid;
/// use std::time::SystemTime;
/// use rand::prelude::*;
///
/// let mut rng = StdRng::from_entropy();
/// let mut gen = Generator::new();
///
/// let ulid1 = gen.generate_with_source(&mut rng).unwrap();
/// let ulid2 = gen.generate_with_source(&mut rng).unwrap();
///
/// assert!(ulid1 < ulid2);
/// ```
pub fn generate_with_source<R>(&mut self, source: &mut R) -> Result<Ulid, MonotonicError>
where
R: rand::Rng + ?Sized,
{
let now = SystemTime::now();
self.generate_from_datetime_with_source(now, source)
}
/// Generate a new monotonic increasing Ulid with the given source matching the given DateTime
/// Each call is guaranteed to provide a Ulid with a larger value than the last call.
/// If the random bits would overflow, this method will return an error.
///
/// # Example
/// ```rust
/// use ulid::Generator;
/// use std::time::SystemTime;
/// use rand::prelude::*;
///
/// let dt = SystemTime::now();
/// let mut rng = StdRng::from_entropy();
/// let mut gen = Generator::new();
///
/// let ulid1 = gen.generate_from_datetime_with_source(dt, &mut rng).unwrap();
/// let ulid2 = gen.generate_from_datetime_with_source(dt, &mut rng).unwrap();
///
/// assert_eq!(ulid1.datetime(), ulid2.datetime());
/// assert!(ulid1 < ulid2);
/// ```
pub fn generate_from_datetime_with_source<R>(
&mut self,
datetime: SystemTime,
source: &mut R,
) -> Result<Ulid, MonotonicError>
where
R: rand::Rng + ?Sized,
{
let last_ms = self.previous.timestamp_ms();
// maybe time went backward, or it is the same ms.
// increment instead of generating a new random so that it is monotonic
if datetime
.duration_since(SystemTime::UNIX_EPOCH)
.unwrap_or(Duration::ZERO)
.as_millis()
<= u128::from(last_ms)
{
if let Some(next) = self.previous.increment() {
self.previous = next;
return Ok(next);
} else {
return Err(MonotonicError::Overflow);
}
}
let next = Ulid::from_datetime_with_source(datetime, source);
self.previous = next;
Ok(next)
}
}
impl Default for Generator {
fn default() -> Self {
Self::new()
}
}
/// Error while trying to generate a monotonic increment in the same millisecond
#[derive(Debug, PartialEq, Eq, Hash, Copy, Clone)]
pub enum MonotonicError {
/// Would overflow into the next millisecond
Overflow,
}
impl std::error::Error for MonotonicError {}
impl fmt::Display for MonotonicError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
let text = match *self {
MonotonicError::Overflow => "Ulid random bits would overflow",
};
write!(f, "{}", text)
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::time::Duration;
#[test]
fn test_order_monotonic() {
let dt = SystemTime::now();
let mut gen = Generator::new();
let ulid1 = gen.generate_from_datetime(dt).unwrap();
let ulid2 = gen.generate_from_datetime(dt).unwrap();
let ulid3 = Ulid::from_datetime(dt + Duration::from_millis(1));
assert_eq!(ulid1.0 + 1, ulid2.0);
assert!(ulid2 < ulid3);
assert!(ulid2.timestamp_ms() < ulid3.timestamp_ms())
}
#[test]
fn test_order_monotonic_with_source() {
use rand::rngs::mock::StepRng;
let mut source = StepRng::new(123, 0);
let mut gen = Generator::new();
let _has_default = Generator::default();
let ulid1 = gen.generate_with_source(&mut source).unwrap();
let ulid2 = gen.generate_with_source(&mut source).unwrap();
assert!(ulid1 < ulid2);
}
#[test]
fn can_display_things() {
println!("{}", MonotonicError::Overflow);
}
}