Struct Id

pub struct Id<T: PrefixedId> { /* private fields */ }

Implementations

impl<T: PrefixedId> Id<T>

pub fn unprefixed(&self) -> Ulid

impl<T: PrefixedId> Id<T>

pub fn new() -> Self

Methods from Deref<Target = Ulid>

pub fn datetime(&self) -> SystemTime

Gets the datetime of when this Ulid was created accurate to 1ms

Example

use std::time::{SystemTime, Duration};
use ulid::Ulid;

let dt = SystemTime::now();
let ulid = Ulid::from_datetime(dt);

assert!(
    dt + Duration::from_millis(1) >= ulid.datetime()
    && dt - Duration::from_millis(1) <= ulid.datetime()
);

pub const TIME_BITS: u8 = 48u8

pub const RAND_BITS: u8 = 80u8

pub fn timestamp_ms(&self) -> u64

Gets the timestamp section of this ulid

Example

use std::time::{SystemTime, Duration};
use ulid::Ulid;

let dt = SystemTime::now();
let ulid = Ulid::from_datetime(dt);

assert_eq!(u128::from(ulid.timestamp_ms()), dt.duration_since(SystemTime::UNIX_EPOCH).unwrap_or(Duration::ZERO).as_millis());

pub fn random(&self) -> u128

Gets the random section of this ulid

Example

use ulid::Ulid;

let text = "01D39ZY06FGSCTVN4T2V9PKHFZ";
let ulid = Ulid::from_string(text).unwrap();
let ulid_next = ulid.increment().unwrap();

assert_eq!(ulid.random() + 1, ulid_next.random());

pub fn to_str<'buf>( &self, buf: &'buf mut [u8], ) -> Result<&'buf mut str, EncodeError>

👎Deprecated since 1.2.0: Use the infallible array_to_str instead.

Creates a Crockford Base32 encoded string that represents this Ulid

Example

use ulid::Ulid;

let text = "01D39ZY06FGSCTVN4T2V9PKHFZ";
let ulid = Ulid::from_string(text).unwrap();

let mut buf = [0; ulid::ULID_LEN];
let new_text = ulid.to_str(&mut buf).unwrap();

assert_eq!(new_text, text);

pub fn array_to_str<'buf>(&self, buf: &'buf mut [u8; 26]) -> &'buf mut str

Creates a Crockford Base32 encoded string that represents this Ulid

Example

use ulid::Ulid;

let text = "01D39ZY06FGSCTVN4T2V9PKHFZ";
let ulid = Ulid::from_string(text).unwrap();

let mut buf = [0; ulid::ULID_LEN];
let new_text = ulid.array_to_str(&mut buf);

assert_eq!(new_text, text);

pub fn to_string(&self) -> String

Creates a Crockford Base32 encoded string that represents this Ulid

Example

use ulid::Ulid;

let text = "01D39ZY06FGSCTVN4T2V9PKHFZ";
let ulid = Ulid::from_string(text).unwrap();

assert_eq!(&ulid.to_string(), text);

pub fn is_nil(&self) -> bool

Test if the Ulid is nil

Example

use ulid::Ulid;

let ulid = Ulid::new();
assert!(!ulid.is_nil());

let nil = Ulid::nil();
assert!(nil.is_nil());

pub fn increment(&self) -> Option<Ulid>

Increment the random number, make sure that the ts millis stays the same

pub fn to_bytes(&self) -> [u8; 16]

Returns the bytes of the Ulid in big-endian order.

Example

use ulid::Ulid;

let text = "7ZZZZZZZZZZZZZZZZZZZZZZZZZ";
let ulid = Ulid::from_string(text).unwrap();

assert_eq!(ulid.to_bytes(), [0xFF; 16]);

Trait Implementations

impl<'__expr, T: PrefixedId> AsExpression<Nullable<Uuid>> for &'__expr Id<T>

type Expression = Bound<Nullable<Uuid>, &'__expr Id<T>>

The expression being returned

fn as_expression(self) -> <Self as AsExpression<Nullable<Uuid>>>::Expression

Perform the conversion

impl<T: PrefixedId> AsExpression<Nullable<Uuid>> for Id<T>

type Expression = Bound<Nullable<Uuid>, Id<T>>

The expression being returned

fn as_expression(self) -> <Self as AsExpression<Nullable<Uuid>>>::Expression

Perform the conversion

impl<'__expr, T: PrefixedId> AsExpression<Uuid> for &'__expr Id<T>

type Expression = Bound<Uuid, &'__expr Id<T>>

The expression being returned

fn as_expression(self) -> <Self as AsExpression<Uuid>>::Expression

Perform the conversion

impl<T: PrefixedId> AsExpression<Uuid> for Id<T>

type Expression = Bound<Uuid, Id<T>>

The expression being returned

fn as_expression(self) -> <Self as AsExpression<Uuid>>::Expression

Perform the conversion

impl<T: PrefixedId> Clone for Id<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: PrefixedId> Debug for Id<T>

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

Formats the value using the given formatter.

impl<T: PrefixedId> Default for Id<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for Id<T>

where T: PrefixedId,

type Target = Ulid

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: PrefixedId> Display for Id<T>

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

Formats the value using the given formatter.

impl<T, I> From<I> for Id<T>

where T: PrefixedId, I: Into<Ulid>,

fn from(id: I) -> Self

Converts to this type from the input type.

impl<T: PrefixedId> From<Id<T>> for Uuid

fn from(value: Id<T>) -> Self

Converts to this type from the input type.

impl<T> FromSql<Uuid, Pg> for Id<T>

where T: PrefixedId,

fn from_sql(bytes: PgValue<'_>) -> Result<Self>

See the trait documentation.

fn from_nullable_sql( bytes: Option<<DB as Backend>::RawValue<'_>>, ) -> Result<Self, Box<dyn Error + Sync + Send>>

A specialized variant of from_sql for handling null values.

impl<T: PrefixedId> FromStr for Id<T>

type Err = IdParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<T: PrefixedId> Hash for Id<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PrefixedId> PartialEq for Id<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PrefixedId, __DB, __ST> Queryable<__ST, __DB> for Id<T>

where __DB: Backend, __ST: SingleValue, Self: FromSql<__ST, __DB>,

type Row = Id<T>

The Rust type you’d like to map from.

fn build(row: Self) -> Result<Self>

Construct an instance of this type

impl<T: PrefixedId> Serialize for Id<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PrefixedId, __DB> ToSql<Nullable<Uuid>, __DB> for Id<T>

where __DB: Backend, Self: ToSql<Uuid, __DB>,

fn to_sql<'__b>(&'__b self, out: &mut Output<'__b, '_, __DB>) -> Result

See the trait documentation.

impl<T> ToSql<Uuid, Pg> for Id<T>

where T: PrefixedId + Debug,

fn to_sql<'b>(&'b self, out: &mut Output<'b, '_, Pg>) -> Result

See the trait documentation.

impl<T: PrefixedId> Copy for Id<T>

impl<T: PrefixedId> Eq for Id<T>