Struct lolid::Uuid

#[repr(transparent)]
pub struct Uuid { /* fields omitted */ }

Universally unique identifier, consisting of 128-bits, as according to RFC4122

Implementations

impl Uuid

pub const fn nil() -> Self

Creates zero UUID

pub const fn from_bytes(data: [u8; 16]) -> Self

Creates new Uuid from raw bytes.

pub const fn from_slice(data: &[u8]) -> Option<Uuid>

Creates new Uuid from byte slice, if its size is 16, otherwise None

pub const fn from_guid(d1: u32, d2: u16, d3: u16, d4: [u8; 8]) -> Self

Creates UUID from GUID converting integer fields to big endian while d4 is copied as it is.

Note that it is assumed that GUID was correctly created in little endian format (e.g. using winapi CoCreateGuid which internally uses UuidCreate which in turn relies on secure random) Effectively winapi GUID would result in creation of UUID of Random variant.

pub const fn as_bytes(&self) -> &[u8]

Access underlying bytes as slice.

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

Get underlying raw bytes

pub const fn time_low(&self) -> u32

Returns time_low part of uuid.

Refer to https://en.wikipedia.org/wiki/Universally_unique_identifier#Format

pub const fn time_mid(&self) -> u16

Returns time_mid part of uuid.

Refer to https://en.wikipedia.org/wiki/Universally_unique_identifier#Format

pub const fn time_high_and_version(&self) -> u16

Returns time_high_and_version part of uuid.

Refer to https://en.wikipedia.org/wiki/Universally_unique_identifier#Format

pub const fn clock_sequence(&self) -> u16

Returns clock_sequence part of uuid.

Refer to https://en.wikipedia.org/wiki/Universally_unique_identifier#Format

pub const fn node(&self) -> [u8; 6]

Returns node part of uuid.

Refer to https://en.wikipedia.org/wiki/Universally_unique_identifier#Format

pub const fn is_version(&self, version: Version) -> bool

Checks if UUID version is equal to the provided version

pub const fn is_variant(&self) -> bool

Checks if UUID variant is set, only cares about RFC4122 byte

pub const fn v1(timestamp: Timestamp, mac: [u8; 6]) -> Self

Generates UUID from time and mac address

pub const fn v3(namespace: Uuid, name: &[u8]) -> Self

Generates UUID v3 by using md5 hasher

Only available when md5 feature is enabled.

pub const fn v4_from(random: [u8; 16]) -> Self

Constructs UUID v4 from provided bytes, assuming they are random.

It is up to user to guarantee that it is random.

This function only sets corresponding bits for v4

pub fn v4() -> Self

Generates UUID v4 using OS RNG from getrandom

Only available when osrng feature is enabled.

pub fn prng() -> Self

Generates UUID v4 using PRNG from wyhash

Only available when prng feature is enabled.

This random variant generates predictable UUID, even though they are unique. Which means that each time program starts, it is initialized with the same seed and therefore would repeat UUIDs

This random is useful when you want to generate predictable but unique UUIDs Otherwise use v4

pub const fn v5(namespace: Uuid, name: &[u8]) -> Self

Generates UUID v5 by using sha1 hasher

Only available when sha1 feature is enabled.

pub const fn set_variant(self) -> Self

Adds variant byte to the corresponding field.

This implementation only cares about RFC4122, there is no option to set other variant.

Useful when user is supplied with random bytes, and wants to create UUID from it.

pub const fn set_version(self, version: Version) -> Self

Adds version byte to the corresponding field.

Useful when user is supplied with random bytes, and wants to create UUID from it.

pub const fn parse_ascii_bytes(input: &[u8]) -> Result<Self, ParseError>

Creates new instance by parsing provided bytes.

Use this when you want to avoid performing utf-8 checks and directly feed bytes. As long as supplied bytes contain valid ascii characters it will parse successfully. Otherwise it shall fail with invalid character.

Supports only simple sequence of characters and - separated.

pub const fn parse_str(input: &str) -> Result<Self, ParseError>

Creates new instance by parsing provided string.

Supports only simple sequence of characters and - separated.

pub const fn to_str(&self) -> StrBuf<36>

Creates textual representation of UUID in a static buffer.

Trait Implementations

impl AsRef<[u8]> for Uuid

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Clone for Uuid

fn clone(&self) -> Uuid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Uuid

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

Formats the value using the given formatter.

impl Default for Uuid

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Uuid

fn deserialize<D: Deserializer<'de>>(des: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Uuid

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

Formats the value using the given formatter.

impl From<[u8; 16]> for Uuid

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

Performs the conversion.

impl FromStr for Uuid

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for Uuid

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Uuid> for Uuid

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

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

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

This method tests for !=.

impl PartialOrd<Uuid> for Uuid

fn partial_cmp(&self, other: &Uuid) -> 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 Serialize for Uuid

fn serialize<SER: Serializer>(&self, ser: SER) -> Result<SER::Ok, SER::Error>

Serialize this value into the given Serde serializer.

impl Copy for Uuid

impl Eq for Uuid

impl StructuralEq for Uuid

impl StructuralPartialEq for Uuid