Struct uuid7::Uuid

#[repr(transparent)]
pub struct Uuid(/* private fields */);

Represents a Universally Unique IDentifier.

Implementations

impl Uuid

pub const NIL: Self = _

The Nil UUID value (00000000-0000-0000-0000-000000000000).

pub const MAX: Self = _

The Max UUID value (ffffffff-ffff-ffff-ffff-ffffffffffff).

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

Returns a reference to the underlying byte array.

pub const fn from_fields_v7(unix_ts_ms: u64, rand_a: u16, rand_b: u64) -> Self

Creates a UUID byte array from UUIDv7 field values.

pub const fn encode(&self) -> FStr<36>

Returns the 8-4-4-4-12 hexadecimal string representation stored in a stack-allocated string-like type that can be handled like String through Deref<Target = str> and other common traits.

Examples

use uuid7::Uuid;

let x = "01809424-3e59-7c05-9219-566f82fff672".parse::<Uuid>()?;
let y = x.encode();
assert_eq!(y, "01809424-3e59-7c05-9219-566f82fff672");
assert_eq!(format!("{}", y), "01809424-3e59-7c05-9219-566f82fff672");

pub const fn encode_hex(&self) -> FStr<32>

Returns the 32-digit hexadecimal string representation without hyphens stored in a stack-allocated string-like type that can be handled like String through Deref<Target = str> and other common traits.

Examples

use uuid7::Uuid;

let x = "01809424-3e59-7c05-9219-566f82fff672".parse::<Uuid>()?;
let y = x.encode_hex();
assert_eq!(y, "018094243e597c059219566f82fff672");
assert_eq!(format!("{}", y), "018094243e597c059219566f82fff672");

pub fn variant(&self) -> Variant

Reports the variant field value of the UUID or, if appropriate, Nil or Max.

For convenience, this function reports Variant::Nil or Variant::Max if self represents the Nil or Max UUID, although the Nil and Max UUIDs are technically subsumed under the variants 0b0 and 0b111, respectively.

pub fn version(&self) -> Option<u8>

Returns the version field value of the UUID or None if self does not have the variant field value of 0b10.

Trait Implementations

impl AsRef<[u8]> for Uuid

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

Converts this type into a shared reference of the (usually inferred) input type.

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Uuid

fn default() -> Uuid

Returns the “default value” for a type.

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

Available on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

impl Display for Uuid

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

Returns the 8-4-4-4-12 canonical hexadecimal string representation.

impl From<[u8; 16]> for Uuid

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

Converts to this type from the input type.

impl From<Uuid> for [u8; 16]

fn from(src: Uuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for String

Available on crate feature std only.

fn from(src: Uuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for Uuid

Available on crate feature uuid only.

fn from(src: Uuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for Uuid

Available on crate feature uuid only.

fn from(src: Uuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for u128

fn from(src: Uuid) -> Self

Converts to this type from the input type.

impl From<u128> for Uuid

fn from(src: u128) -> Self

Converts to this type from the input type.

impl FromStr for Uuid

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

Creates an object from the 8-4-4-4-12 hexadecimal string representation.

type Err = ParseError

The associated error which can be returned from parsing.

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, Self: Sized,

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) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<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: &Rhs) -> bool

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

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

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<String> for Uuid

Available on crate feature std only.

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(src: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Uuid

impl Eq for Uuid

impl StructuralEq for Uuid

impl StructuralPartialEq for Uuid