Struct ulid_generator_rs::ULID

pub struct ULID(_);

This struct is ULID.

Implementations

impl ULID

implements for ULID.

#[must_use]pub fn new(value: u128) -> Self

The Constructor for ULID.

Example

ULID::new() is used to create a ULID instance, but usually ULIDGenerator is used.

use ulid_generator_rs::{ULID, ULIDGenerator};

let ulid: ULID = ULID::new(1945530789360716160560926739305506752);

// Use `ULIDGenerator::generate` as follows
let ulid: ULID = ULIDGenerator::new().generate().unwrap();

#[must_use]pub fn to_string(&self) -> String

Converts a ULID to a string representation.

Example

use ulid_generator_rs::ULIDGenerator;

let ulid = ULIDGenerator::new().generate().unwrap();
let str = ulid.to_string();
println!("{}", str); // "01ETGRM6448X1HM0PYWG2KT648"

pub fn increment(&self) -> Self

Increment this ULID.

Example

use ulid_generator_rs::ULIDGenerator;
let ulid = ULIDGenerator::new().generate().unwrap();
let next_ulid = ulid.increment();

#[must_use]pub const fn most_significant_bits(&self) -> u64

Most significant bits.

Example

use ulid_generator_rs::{ULIDGenerator, ULID};

let ulid: ULID = ULIDGenerator::new().generate().unwrap();
let m: u64 = ulid.most_significant_bits();

#[must_use]pub const fn least_significant_bits(&self) -> u64

Least significant bits.

Example

use ulid_generator_rs::{ULIDGenerator, ULID};

let ulid: ULID = ULIDGenerator::new().generate().unwrap();
let l: u64 = ulid.least_significant_bits();

#[must_use]pub const fn to_epoch_milli_as_long(&self) -> i64

Converts a ULID to a epoch time as milli seconds.

Example

use ulid_generator_rs::{ULIDGenerator, ULID};

let ulid: ULID = ULIDGenerator::new().generate().unwrap();
let epoch: i64 = ulid.to_epoch_milli_as_long();

#[must_use]pub fn to_date_time(&self) -> DateTime<Local>

Converts a ULID to a DateTime<Local>

Example

use ulid_generator_rs::{ULIDGenerator, ULID};
use chrono::{Local, DateTime};

let ulid: ULID = ULIDGenerator::new().generate().unwrap();
let date_time: DateTime<Local> = ulid.to_date_time();

#[must_use]pub fn to_byte_array(&self, endian: Endian) -> Vec<u8>

Converts a ULID to a byte array.

endian a Endian of byte array

Example

use ulid_generator_rs::{ULIDGenerator, ULID, Endian};

let ulid: ULID = ULIDGenerator::new().generate().unwrap();
let ba: Vec<u8> = ulid.to_byte_array(Endian::BE);

pub fn parse_from_byte_array(
    byte_array: Vec<u8>,
    endian: Endian
) -> Result<Self, ULIDError>

Parse a byte array as ULID.

byte_array a byte array as ULID. endian a Endian of byte_array.

Example

use ulid_generator_rs::{ULIDGenerator, ULID, Endian};

let ulid: ULID = ULIDGenerator::new().generate().unwrap();
let ba: Vec<u8> = ulid.to_byte_array(Endian::BE);
let ulid: ULID = ULID::parse_from_byte_array(ba, Endian::BE).unwrap();

Trait Implementations

impl Clone for ULID

pub fn clone(&self) -> ULID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ULID

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

Formats the value using the given formatter.

impl Display for ULID

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

Formats the value using the given formatter.

impl From<(u64, u64)> for ULID

pub fn from((most_significant_bits, least_significant_bits): (u64, u64)) -> Self

use ulid_generator_rs::ULID;

let ulid: ULID = (105449255778666307, 1874305465861347464).into();

impl From<u128> for ULID

pub fn from(value: u128) -> Self

use ulid_generator_rs::ULID;

let ulid: ULID = 1945530789360716160560926739305506752.into();

impl FromStr for ULID

type Err = ULIDError

The associated error which can be returned from parsing.

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

use ulid_generator_rs::ULID;

let ulid: ULID = "01ETGRM6448X1HM0PYWG2KT648".parse::<ULID>().unwrap();

impl PartialEq<ULID> for ULID

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ULID> for ULID

pub fn partial_cmp(&self, other: &ULID) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &ULID) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &ULID) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &ULID) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &ULID) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ULID

impl TryFrom<Vec<u8, Global>> for ULID

type Error = ULIDError

The type returned in the event of a conversion error.

pub fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

use ulid_generator_rs::{ULID, Endian};
use std::convert::TryInto;

let ulid: ULID = 1945530789360716160560926739305506752.into();
let bytes: Vec<u8> = ulid.to_byte_array(Endian::BE);
let ulid: ULID = bytes.try_into().unwrap();