Struct ulid::Generator

source ·
pub struct Generator { /* private fields */ }
Expand description

A Ulid generator that provides monotonically increasing Ulids

Implementations§

source§

impl Generator

source

pub fn new() -> Generator

Create a new ulid generator for monotonically ordered ulids

§Example
use ulid::Generator;

let mut gen = Generator::new();

let ulid1 = gen.generate().unwrap();
let ulid2 = gen.generate().unwrap();

assert!(ulid1 < ulid2);
source

pub fn generate(&mut self) -> Result<Ulid, MonotonicError>

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.

use ulid::Generator;
let mut gen = Generator::new();

let ulid1 = gen.generate().unwrap();
let ulid2 = gen.generate().unwrap();

assert!(ulid1 < ulid2);
source

pub fn generate_from_datetime( &mut self, datetime: SystemTime ) -> Result<Ulid, MonotonicError>

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
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);
source

pub fn generate_with_source<R>( &mut self, source: &mut R ) -> Result<Ulid, MonotonicError>
where R: Rng + ?Sized,

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
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);
source

pub fn generate_from_datetime_with_source<R>( &mut self, datetime: SystemTime, source: &mut R ) -> Result<Ulid, MonotonicError>
where R: Rng + ?Sized,

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
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);

Trait Implementations§

source§

impl Default for Generator

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V