https://github.com/uuid-rs/uuid

Generate and parse UUIDs.
https://github.com/uuid-rs/uuid

parse-uuids rust uuid

Last synced: 13 days ago
JSON representation

Generate and parse UUIDs.

• Host: GitHub
• URL: https://github.com/uuid-rs/uuid
• Owner: uuid-rs
• License: other
• Created: 2014-07-30T22:03:55.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2024-10-16T04:29:59.000Z (29 days ago)
• Last Synced: 2024-10-25T01:48:12.456Z (20 days ago)
• Topics: parse-uuids, rust, uuid
• Language: Rust
• Homepage: https://www.crates.io/crates/uuid
• Size: 1.73 MB
• Stars: 999
• Watchers: 12
• Forks: 191
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-APACHE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# `uuid`

[![Latest Version](https://img.shields.io/crates/v/uuid.svg)](https://crates.io/crates/uuid)

[![Continuous integration](https://github.com/uuid-rs/uuid/actions/workflows/ci.yml/badge.svg)](https://github.com/uuid-rs/uuid/actions/workflows/ci.yml)

Here's an example of a UUID:

```text

67e55044-10b1-426f-9247-bb680e5fe0c8

```

A UUID is a unique 128-bit value, stored as 16 octets, and regularly

formatted as a hex string in five groups. 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.

## Getting started

Add the following to your `Cargo.toml`:

```toml

[dependencies.uuid]

version = "1.10.0"

features = [

    "v4",                # Lets you generate random UUIDs

    "fast-rng",          # Use a faster (but still sufficiently random) RNG

    "macro-diagnostics", # Enable better diagnostics for compile-time UUIDs

]

```

When you want a UUID, you can generate one:

```rust

use uuid::Uuid;

let id = Uuid::new_v4();

```

If you have a UUID value, you can use its string literal form inline:

```rust

use uuid::{uuid, Uuid};

const ID: Uuid = uuid!("67e55044-10b1-426f-9247-bb680e5fe0c8");

```

You can also parse UUIDs without needing any crate features:

```rust

use uuid::{Uuid, Version};

let my_uuid = Uuid::parse_str("67e55044-10b1-426f-9247-bb680e5fe0c8")?;

assert_eq!(Some(Version::Random), my_uuid.get_version());

```

If you'd like to parse UUIDs _really_ fast, check out the [`uuid-simd`](https://github.com/nugine/uuid-simd)

library.

For more details on using `uuid`, [see the library documentation](https://docs.rs/uuid/1.10.0/uuid).

## References

* [`uuid` library docs](https://docs.rs/uuid/1.10.0/uuid).

* [Wikipedia: Universally Unique Identifier](http://en.wikipedia.org/wiki/Universally_unique_identifier).

* [RFC 9562: Universally Unique IDentifiers (UUID)](https://www.ietf.org/rfc/rfc9562.html).

---

# 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.

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fuuid-rs%2Fuuid.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fuuid-rs%2Fuuid?ref=badge_large)

## 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.