Struct EUID 

pub struct EUID(/* private fields */);

Extendable Universally Unique Identifier or EUID contains two main components: header and random number.

Binary layout (Big Endian):

       0               1               2               3
0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                         Timestamp High                        |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|      Timestamp Low      | N Bit Random + Ops Ext Data |Ext Len|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                             Random                            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                             Random                            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Implementations

impl EUID

A Standard implementation of EUID.

pub fn create() -> Option<EUID>

Create random EUID. None will returns if the EUID is created after Friday, December 12, 3084 12:41:28.831 PM (UTC).

Example:

use euid::EUID;

let euid: EUID = EUID::create().unwrap_or_default();
println!("{}", euid); // with check-mod.
println!("{}", euid.encode(true)); // with check-mod.
println!("{}", euid.encode(false)); // without check-mod.

pub fn create_with_extension(extension: u16) -> Option<EUID>

Create random EUID with attachable data (max 15 bit). None will returns if the EUID is created after Friday, December 12, 3084 12:41:28.831 PM (UTC) or the extenstion (user attached data) is more then 15 bits.

Example:

use euid::EUID;

let euid: EUID = EUID::create_with_extension(1).unwrap_or_default();
println!("{}", euid); // with check-mod.
println!("{}", euid.encode(true)); // with check-mod.
println!("{}", euid.encode(false)); // without check-mod.

let overflowed_euid: Option<EUID> = EUID::create_with_extension(32768);
assert_eq!(None, overflowed_euid);

pub fn extension(&self) -> Option<u16>

Returns user attached data (extension), or None if no attached data.

pub fn timestamp(&self) -> u64

Returns timestamp in milliseconds.

pub fn next(&self) -> Option<EUID>

Derive monotonic EUID.

This function generate sortable EUID, None returns if overflow happens when incrementing randomness.

pub fn encode(&self, checkmod: bool) -> String

Encode EUID to string Base-32 string.

Example:

use euid::EUID;

let euid: EUID = EUID::create().unwrap_or_default();
println!("{}", euid.encode(true)); // with check-mod.
println!("{}", euid.encode(false)); // without check-mod.

Trait Implementations

impl Clone for EUID

fn clone(&self) -> EUID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EUID

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

Formats the value using the given formatter.

impl Default for EUID

fn default() -> EUID

Returns the “default value” for a type.

impl Display for EUID

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

Encode to lexicographically sortable string.

impl From<[u8; 16]> for EUID

fn from(value: [u8; 16]) -> Self

Converts to this type from the input type.

impl From<EUID> for [u8; 16]

fn from(value: EUID) -> Self

Converts to this type from the input type.

impl From<EUID> for u128

fn from(val: EUID) -> Self

Converts to this type from the input type.

impl From<u128> for EUID

fn from(value: u128) -> EUID

Converts to this type from the input type.

impl FromStr for EUID

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

Parse string representation of EUID.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for EUID

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 EUID

fn cmp(&self, other: &Self) -> 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,

Restrict a value to a certain interval.

impl PartialEq for EUID

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 PartialOrd for EUID

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for EUID

impl Eq for EUID