Struct yyid::Yyid

pub struct Yyid(_);

A yniversally ynique identifier (Yyid).

Methods

impl<'a> Yyid

pub const fn to_hyphenated_ref(&self) -> HyphenatedRef

Creates a HyphenatedRef from a Yyid

pub const fn to_simple_ref(&self) -> SimpleRef

Creates a SimpleRef from a Yyid

pub const fn to_urn_ref(&self) -> UrnRef

Creates a UrnRef from a Yyid

impl<'a> Yyid

pub fn new() -> Self

Creates a new random YYID

Example

use yyid::Yyid;

let yyid = Yyid::new();
println!("{}", yyid);
// => "02e7f0f6-067e-8c92-b25c-12c9180540a9"

pub const fn nil() -> Self

Special case: a "nil" YYID

Example

use yyid::Yyid;

let nil = Yyid::nil();
assert_eq!(
    nil.to_string(),
    "00000000-0000-0000-0000-000000000000"
);
assert_eq!(nil.as_bytes(), &[0u8; 16]);

pub fn is_nil(&self) -> bool

Tests if the YYID is nil.

pub fn as_bytes(&self) -> &Bytes

Return an array of 16 octets containing the YYID data

pub fn to_u128(&self) -> u128

Returns a 128bit value containing the YYID data.

pub fn to_u128_le(&self) -> u128

Returns a 128bit little-endian value containing the YYID data.

Trait Implementations

impl Clone for Yyid

fn clone(&self) -> Yyid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Yyid

impl Debug for Yyid

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

Formats the value using the given formatter.

impl Default for Yyid

fn default() -> Self

Returns the "default value" for a type.

impl Display for Yyid

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

Formats the value using the given formatter.

impl Eq for Yyid

impl Hash for Yyid

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, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for Yyid

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

Formats the value using the given formatter.

impl Ord for Yyid

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Yyid> for Yyid

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

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

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

This method tests for !=.

impl PartialOrd<Yyid> for Yyid

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Yyid

impl StructuralPartialEq for Yyid