Struct upid::Upid

pub struct Upid(pub u128);

A Upid is a unique 128-bit identifier is sortable and has a useful prefix.

It is encoded as a 26 character string using a custom base32 alphabet based on Crockford’s, but with lower-case and prioritising letters over numerals. In the binary, the first 40 bits are a unix timestamp with 256ms precision, the next 64 are random bits, and the last 24 are the prefix and version identifier.

Tuple Fields

0: u128

Implementations

impl Upid

pub fn new(prefix: &str) -> Upid

Creates a new Upid with the provided prefix and current time (UTC)

The prefix should only contain lower-case latin alphabet characters.

Example

use upid::Upid;

let my_upid = Upid::new("user");

pub fn from_prefix(prefix: &str) -> Upid

Creates a Upid with the provided prefix and current time (UTC)

The prefix should contain four lower-case latin alphabet characters.

Example

use upid::Upid;

let my_upid = Upid::from_prefix("user");

pub fn from_prefix_and_datetime(prefix: &str, datetime: SystemTime) -> Upid

Creates a new Upid with the given prefix and datetime

The prefix should only contain lower-case latin alphabet characters.

This will take the maximum of the [SystemTime] argument and [SystemTime::UNIX_EPOCH] as earlier times are not valid for a Upid timestamp

Example

use std::time::{SystemTime, Duration};
use upid::Upid;

let upid = Upid::from_prefix_and_datetime("user", SystemTime::now());

pub fn from_prefix_and_milliseconds(prefix: &str, milliseconds: u128) -> Upid

Creates a new Upid with the given prefix and timestamp in millisecons

The prefix should only contain lower-case latin alphabet characters.

Example

use upid::Upid;

let ms: u128 = 1720568902000;
let upid = Upid::from_prefix_and_milliseconds("user", ms);

pub fn from_string(encoded: &str) -> Result<Upid, DecodeError>

Creates a Upid from a Base32 encoded string

Example

use upid::Upid;

let text = "user_aaccvpp5guht4dts56je5a";
let result = Upid::from_string(text);

assert_eq!(&result.unwrap().to_string(), text);

pub fn datetime(&self) -> SystemTime

Gets the datetime of when this Upid was created accurate to around 256ms

Example

use std::time::{SystemTime, Duration};
use upid::Upid;

let dt = SystemTime::now();
let upid = Upid::from_prefix_and_datetime("user", dt);

assert!(dt + Duration::from_millis(257) >= upid.datetime());

pub fn prefix(&self) -> String

Gets the prefix of this upid

Example

use upid::Upid;

let prefix = "user";
let upid = Upid::from_prefix(prefix);

assert_eq!(upid.prefix(), prefix);

pub const fn milliseconds(&self) -> u64

Gets the timestamp section of this upid

Example

use upid::Upid;

let ms: u128 = 1720568902000;
let upid = Upid::from_prefix_and_milliseconds("user", ms);

assert!(ms - u128::from(upid.milliseconds()) < 257);

pub fn to_string(&self) -> String

Creates a Base32 encoded string that represents this Upid

Example

use upid::Upid;

let text = "user_aaccvpp5guht4dts56je5a";
let upid = Upid::from_string(text).unwrap();

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

pub const fn from_bytes(bytes: [u8; 16]) -> Upid

Creates a Upid using the provided bytes array.

Example

use upid::Upid;
let bytes = [0xFF; 16];

let upid = Upid::from_bytes(bytes);

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

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

Example

use upid::Upid;

let text = "user_aaccvpp5guht4dts56je5a";
let upid = Upid::from_string(text).unwrap();

Trait Implementations

impl Clone for Upid

fn clone(&self) -> Upid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Upid

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

Formats the value using the given formatter.

impl Default for Upid

fn default() -> Self

Returns the “default value” for a type.

impl Display for Upid

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

Formats the value using the given formatter.

impl From<Upid> for String

fn from(upid: Upid) -> String

Converts to this type from the input type.

impl From<Upid> for u128

fn from(upid: Upid) -> u128

Converts to this type from the input type.

impl From<u128> for Upid

fn from(value: u128) -> Upid

Converts to this type from the input type.

impl FromStr for Upid

type Err = DecodeError

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 Hash for Upid

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 Ord for Upid

fn cmp(&self, other: &Upid) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Upid

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

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

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

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

impl PartialOrd for Upid

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

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

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

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

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

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

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

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

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

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

impl Copy for Upid

impl Eq for Upid

impl StructuralPartialEq for Upid