Struct Uuid

pub struct Uuid {
    pub inner: Uuid,
}

Uuid

Fields

inner: Uuid

Implementations

impl Uuid

pub fn new() -> Uuid

pub fn parse_str(arg: &str) -> Result<Uuid, Error>

Methods from Deref<Target = Uuid>

pub fn to_hyphenated_ref(&self) -> HyphenatedRef<'_>

Get a borrowed HyphenatedRef formatter.

pub fn to_simple_ref(&self) -> SimpleRef<'_>

Get a borrowed SimpleRef formatter.

pub fn to_urn_ref(&self) -> UrnRef<'_>

Get a borrowed UrnRef formatter.

pub const NAMESPACE_DNS: Uuid

pub const NAMESPACE_OID: Uuid

pub const NAMESPACE_URL: Uuid

pub const NAMESPACE_X500: Uuid

pub fn get_variant(&self) -> Option<Variant>

Returns the variant of the UUID structure.

This determines the interpretation of the structure of the UUID. Currently only the RFC4122 variant is generated by this module.

• Variant Reference

pub fn get_version_num(&self) -> usize

Returns the version number of the UUID.

This represents the algorithm used to generate the contents.

Currently only the Random (V4) algorithm is supported by this module. There are security and privacy implications for using older versions - see Wikipedia: Universally Unique Identifier for details.

• Version Reference

pub fn get_version(&self) -> Option<Version>

Returns the version of the UUID.

This represents the algorithm used to generate the contents

pub fn as_fields(&self) -> (u32, u16, u16, &[u8; 8])

Returns the four field values of the UUID in big-endian order.

These values can be passed to the from_fields() method to get the original Uuid back.

• The first field value represents the first group of (eight) hex digits, taken as a big-endian u32 value. For V1 UUIDs, this field represents the low 32 bits of the timestamp.
• The second field value represents the second group of (four) hex digits, taken as a big-endian u16 value. For V1 UUIDs, this field represents the middle 16 bits of the timestamp.
• The third field value represents the third group of (four) hex digits, taken as a big-endian u16 value. The 4 most significant bits give the UUID version, and for V1 UUIDs, the last 12 bits represent the high 12 bits of the timestamp.
• The last field value represents the last two groups of four and twelve hex digits, taken in order. The first 1-3 bits of this indicate the UUID variant, and for V1 UUIDs, the next 13-15 bits indicate the clock sequence and the last 48 bits indicate the node ID.

Examples

use uuid::Uuid;

fn main() -> Result<(), uuid::Error> {
    let uuid = Uuid::nil();
    assert_eq!(uuid.as_fields(), (0, 0, 0, &[0u8; 8]));

    let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8")?;
    assert_eq!(
        uuid.as_fields(),
        (
            0x936DA01F,
            0x9ABD,
            0x4D9D,
            b"\x80\xC7\x02\xAF\x85\xC8\x22\xA8"
        )
    );

    Ok(())
}

pub fn to_fields_le(&self) -> (u32, u16, u16, &[u8; 8])

Returns the four field values of the UUID in little-endian order.

The bytes in the returned integer fields will be converted from big-endian order.

Examples

use uuid::Uuid;

fn main() -> Result<(), uuid::Error> {
    let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8")?;
    assert_eq!(
        uuid.to_fields_le(),
        (
            0x1FA06D93,
            0xBD9A,
            0x9D4D,
            b"\x80\xC7\x02\xAF\x85\xC8\x22\xA8"
        )
    );
    Ok(())
}

pub fn as_u128(&self) -> u128

Returns a 128bit value containing the UUID data.

The bytes in the UUID will be packed into a u128, like the Uuid::as_bytes method.

Examples

use uuid::Uuid;

fn main() -> Result<(), uuid::Error> {
    let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8")?;
    assert_eq!(
        uuid.as_u128(),
        0x936DA01F9ABD4D9D80C702AF85C822A8,
    );
    Ok(())
}

pub fn to_u128_le(&self) -> u128

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

The bytes in the UUID will be reversed and packed into a u128. Note that this will produce a different result than Uuid::to_fields_le, because the entire UUID is reversed, rather than reversing the individual fields in-place.

Examples

use uuid::Uuid;

fn main() -> Result<(), uuid::Error> {
    let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8")?;

    assert_eq!(
        uuid.to_u128_le(),
        0xA822C885AF02C7809D4DBD9A1FA06D93,
    );
    Ok(())
}

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

Returns an array of 16 octets containing the UUID data.

pub fn is_nil(&self) -> bool

Tests if the UUID is nil.

Trait Implementations

impl Clone for Uuid

fn clone(&self) -> Uuid

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Deref for Uuid

type Target = Uuid

The resulting type after dereferencing.

fn deref(&self) -> &<Uuid as Deref>::Target

Dereferences the value.

impl DerefMut for Uuid

fn deref_mut(&mut self) -> &mut <Uuid as Deref>::Target

Mutably dereferences the value.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Uuid

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

Formats the value using the given formatter.

impl From<&Binary> for Uuid

fn from(arg: &Binary) -> Uuid

Converts to this type from the input type.

impl From<&Uuid> for Uuid

fn from(arg: &Uuid) -> Uuid

Converts to this type from the input type.

impl From<Binary> for Uuid

fn from(arg: Binary) -> Uuid

Converts to this type from the input type.

impl From<Uuid> for Uuid

fn from(arg: Uuid) -> Uuid

Converts to this type from the input type.

impl Hash for Uuid

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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) -> 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 Uuid

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

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Uuid

impl Eq for Uuid

impl StructuralPartialEq for Uuid