[][src]Crate uuid

Generate and parse UUIDs.

Provides support for Universally Unique Identifiers (UUIDs). A UUID is a unique 128-bit number, stored as 16 octets. UUIDs are used to assign unique identifiers to entities without requiring a central allocating authority.

They are particularly useful in distributed systems, though can be used in disparate areas, such as databases and network protocols. Typically a UUID is displayed in a readable string form as a sequence of hexadecimal digits, separated into groups by hyphens.

The uniqueness property is not strictly guaranteed, however for all practical purposes, it can be assumed that an unintentional collision would be extremely unlikely.

Dependencies

By default, this crate depends on nothing but std and cannot generate UUIDs. You need to enable the following Cargo features to enable various pieces of functionality:

For WebAssembly, enable one of the following features depending on your JavaScript interop toolchain of choice:

By default, uuid can be depended on with:

[dependencies]
uuid = "0.8"

To activate various features, use syntax like:

[dependencies]
uuid = { version = "0.8", features = ["serde", "v4"] }

You can disable default features with:

[dependencies]
uuid = { version = "0.8", default-features = false }

Examples

To parse a UUID given in the simple format and print it as a urn:

use uuid::Uuid;

fn main() -> Result<(), uuid::Error> {
    let my_uuid =
        Uuid::parse_str("936DA01F9ABD4d9d80C702AF85C822A8")?;
    println!("{}", my_uuid.to_urn());
    Ok(())
}

To create a new random (V4) UUID and print it out in hexadecimal form:

This example is not tested
// Note that this requires the `v4` feature enabled in the uuid crate.

use uuid::Uuid;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    #[cfg(feature = "v4")] {
        let my_uuid = Uuid::new_v4()?;
        println!("{}", my_uuid);
    }
    Ok(())
}

Strings

Examples of string representations:

References

Modules

adapter

Adapters for various formats for UUIDs

Structs

Builder

A builder struct for creating a UUID.

Error

A general error that can occur when working with UUIDs.

Uuid

A Universally Unique Identifier (UUID).

Enums

Variant

The reserved variants of UUIDs.

Version

The version of the UUID, denoting the generating algorithm.

Type Definitions

Bytes

A 128-bit (16 byte) buffer containing the ID.