tag	872f2e629601ea089c9d651fb1aa05dcef009801
tagger	The Android Open Source Project <initial-contribution@android.com>	Wed May 11 05:15:13 2022 +0000
object	3699735a4088fef441f1308b671984a0352c7ecb

commit	3699735a4088fef441f1308b671984a0352c7ecb	[log] [tgz]
author	Bob Badour <bbadour@google.com>	Tue Mar 23 15:53:44 2021 +0000
committer	Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>	Tue Mar 23 15:53:44 2021 +0000
tree	2c81d2417450e4ac6588744054f58be341bdf31e
parent	4e5e9be77d31c4a9fbc3a4f1377bb8b80d1a7c8f [diff]
parent	641a9eb8d00dbae39228a8b538eee15fb3b7b9c5 [diff]

tree: 2c81d2417450e4ac6588744054f58be341bdf31e

README.md

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 they 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:

v1 - adds the Uuid::new_v1 function and the ability to create a V1 using an implementation of uuid::v1::ClockSequence (usually uuid::v1::Context) and a timestamp from time::timespec.
v3 - adds the Uuid::new_v3 function and the ability to create a V3 UUID based on the MD5 hash of some data.
v4 - adds the Uuid::new_v4 function and the ability to randomly generate a Uuid.
v5 - adds the Uuid::new_v5 function and the ability to create a V5 UUID based on the SHA1 hash of some data.
serde - adds the ability to serialize and deserialize a Uuid using the serde crate.

You need to enable one of the following Cargo features together with v3, v4 or v5 feature if you're targeting wasm32-unknown-unknown target:

stdweb - enables support for OsRng on wasm32-unknown-unknown via stdweb combined with cargo-web
wasm-bindgen - wasm-bindgen enables support for OsRng on wasm32-unknown-unknown via wasm-bindgen

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:

// Note that this requires the `v4` feature enabled in the uuid crate.

use uuid::Uuid;

fn main() {
    let my_uuid = Uuid::new_v4();
    println!("{}", my_uuid);
    Ok(())
}

Strings

Examples of string representations:

simple: 936DA01F9ABD4d9d80C702AF85C822A8
hyphenated: 550e8400-e29b-41d4-a716-446655440000
urn: urn:uuid:F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4

References

License

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.