[][src]Struct uuid::Uuid

pub struct Uuid(_);

A Universally Unique Identifier (UUID).

Methods

impl Uuid[src]

pub const fn nil() -> Self[src]

The 'nil UUID'.

The nil UUID is special form of UUID that is specified to have all 128 bits set to zero, as defined in IETF RFC 4122 Section 4.1.7.

Examples

Basic usage:

use uuid::Uuid;

let uuid = Uuid::nil();

assert_eq!(
    uuid.to_hyphenated().to_string(),
    "00000000-0000-0000-0000-000000000000"
);

pub fn from_fields(d1: u32, d2: u16, d3: u16, d4: &[u8]) -> Result<Uuid, Error>[src]

Creates a UUID from four field values in big-endian order.

Errors

This function will return an error if d4's length is not 8 bytes.

Examples

Basic usage:

use uuid::Uuid;

let d4 = [12, 3, 9, 56, 54, 43, 8, 9];

let uuid = Uuid::from_fields(42, 12, 5, &d4);
let uuid = uuid.map(|uuid| uuid.to_hyphenated().to_string());

let expected_uuid =
    Ok(String::from("0000002a-000c-0005-0c03-0938362b0809"));

assert_eq!(expected_uuid, uuid);

pub fn from_fields_le(
    d1: u32,
    d2: u16,
    d3: u16,
    d4: &[u8]
) -> Result<Uuid, Error>
[src]

Creates a UUID from four field values in little-endian order.

The bytes in the d1, d2 and d3 fields will be converted into big-endian order.

Examples

use uuid::Uuid;

let d1 = 0xAB3F1097u32;
let d2 = 0x501Eu16;
let d3 = 0xB736u16;
let d4 = [12, 3, 9, 56, 54, 43, 8, 9];

let uuid = Uuid::from_fields_le(d1, d2, d3, &d4);
let uuid = uuid.map(|uuid| uuid.to_hyphenated().to_string());

let expected_uuid =
    Ok(String::from("97103fab-1e50-36b7-0c03-0938362b0809"));

assert_eq!(expected_uuid, uuid);

pub const fn from_u128(v: u128) -> Self[src]

Creates a UUID from a 128bit value in big-endian order.

pub const fn from_u128_le(v: u128) -> Self[src]

Creates a UUID from a 128bit value in little-endian order.

pub fn from_slice(b: &[u8]) -> Result<Uuid, Error>[src]

Creates a UUID using the supplied big-endian bytes.

Errors

This function will return an error if b has any length other than 16.

Examples

Basic usage:

use uuid::Uuid;

let bytes = [4, 54, 67, 12, 43, 2, 98, 76, 32, 50, 87, 5, 1, 33, 43, 87];

let uuid = Uuid::from_slice(&bytes);
let uuid = uuid.map(|uuid| uuid.to_hyphenated().to_string());

let expected_uuid =
    Ok(String::from("0436430c-2b02-624c-2032-570501212b57"));

assert_eq!(expected_uuid, uuid);

An incorrect number of bytes:

use uuid::Uuid;

let bytes = [4, 54, 67, 12, 43, 2, 98, 76];

let uuid = Uuid::from_slice(&bytes);

assert!(uuid.is_err());

pub const fn from_bytes(bytes: Bytes) -> Uuid[src]

Creates a UUID using the supplied big-endian bytes.

impl Uuid[src]

pub fn parse_str(input: &str) -> Result<Uuid, Error>[src]

Parses a Uuid from a string of hexadecimal digits with optional hyphens.

Any of the formats generated by this module (simple, hyphenated, urn) are supported by this parsing function.

impl Uuid[src]

pub const fn to_hyphenated(self) -> Hyphenated[src]

Get a Hyphenated formatter.

pub const fn to_hyphenated_ref(&self) -> HyphenatedRef[src]

Get a borrowed HyphenatedRef formatter.

pub const fn to_simple(self) -> Simple[src]

Get a Simple formatter.

pub const fn to_simple_ref(&self) -> SimpleRef[src]

Get a borrowed SimpleRef formatter.

pub const fn to_urn(self) -> Urn[src]

Get a Urn formatter.

pub const fn to_urn_ref(&self) -> UrnRef[src]

Get a borrowed UrnRef formatter.

impl Uuid[src]

pub fn new_v4() -> Self[src]

Creates a random UUID.

This uses the rand crate's default task RNG as the source of random numbers. If you'd like to use a custom generator, don't use this method: use the rand::Rand trait's rand() method instead.

Note that usage of this method requires the v4 feature of this crate to be enabled.

Examples

Basic usage:

use uuid::Uuid;

let uuid = Uuid::new_v4();

impl Uuid[src]

pub const NAMESPACE_DNS: Self[src]

UUID namespace for Domain Name System (DNS).

pub const NAMESPACE_OID: Self[src]

UUID namespace for ISO Object Identifiers (OIDs).

pub const NAMESPACE_URL: Self[src]

UUID namespace for Uniform Resource Locators (URLs).

pub const NAMESPACE_X500: Self[src]

UUID namespace for X.500 Distinguished Names (DNs).

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

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.

pub const fn get_version_num(&self) -> usize[src]

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.

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

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])[src]

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;

let uuid = Uuid::nil();
assert_eq!(uuid.as_fields(), (0, 0, 0, &[0u8; 8]));

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

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

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;

let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8").unwrap();
assert_eq!(
    uuid.to_fields_le(),
    (
        0x1FA06D93,
        0xBD9A,
        0x9D4D,
        b"\x80\xC7\x02\xAF\x85\xC8\x22\xA8"
    )
);

pub fn as_u128(&self) -> u128[src]

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;

let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8").unwrap();
assert_eq!(
    uuid.as_u128(),
    0x936DA01F9ABD4D9D80C702AF85C822A8,
)

pub fn to_u128_le(&self) -> u128[src]

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;

let uuid = Uuid::parse_str("936DA01F-9ABD-4D9D-80C7-02AF85C822A8").unwrap();

assert_eq!(
    uuid.to_u128_le(),
    0xA822C885AF02C7809D4DBD9A1FA06D93,
)

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

Returns an array of 16 octets containing the UUID data.

pub fn is_nil(&self) -> bool[src]

Tests if the UUID is nil.

pub const fn encode_buffer() -> [u8; 45][src]

A buffer that can be used for encode_... calls, that is guaranteed to be long enough for any of the adapters.

Examples

use uuid::Uuid;

let uuid = Uuid::nil();

assert_eq!(
    uuid.to_simple().encode_lower(&mut Uuid::encode_buffer()),
    "00000000000000000000000000000000"
);

assert_eq!(
    uuid.to_hyphenated()
        .encode_lower(&mut Uuid::encode_buffer()),
    "00000000-0000-0000-0000-000000000000"
);

assert_eq!(
    uuid.to_urn().encode_lower(&mut Uuid::encode_buffer()),
    "urn:uuid:00000000-0000-0000-0000-000000000000"
);

Trait Implementations

impl Clone for Uuid[src]

impl Copy for Uuid[src]

impl Debug for Uuid[src]

impl Default for Uuid[src]

impl<'de> Deserialize<'de> for Uuid[src]

impl Display for Uuid[src]

impl Eq for Uuid[src]

impl<'a> From<&'a Uuid> for HyphenatedRef<'a>[src]

impl<'a> From<&'a Uuid> for SimpleRef<'a>[src]

impl<'a> From<&'a Uuid> for UrnRef<'a>[src]

impl From<Uuid> for Hyphenated[src]

impl From<Uuid> for Simple[src]

impl From<Uuid> for Urn[src]

impl FromStr for Uuid[src]

type Err = Error

The associated error which can be returned from parsing.

impl Hash for Uuid[src]

impl LowerHex for Uuid[src]

impl Ord for Uuid[src]

impl PartialEq<Uuid> for Uuid[src]

impl PartialOrd<Uuid> for Uuid[src]

impl Serialize for Uuid[src]

impl StructuralEq for Uuid[src]

impl StructuralPartialEq for Uuid[src]

impl UpperHex for Uuid[src]

Auto Trait Implementations

impl RefUnwindSafe for Uuid

impl Send for Uuid

impl Sync for Uuid

impl Unpin for Uuid

impl UnwindSafe for Uuid

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: Deserialize<'de>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]