Skip to content

Commit bf28001

Browse files
committed
update feature docs
1 parent 920e8b1 commit bf28001

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ Add the following to your `Cargo.toml`:
3131
version = "1.13.1"
3232
features = [
3333
"v4", # Lets you generate random UUIDs
34-
"fast-rng", # Use a faster (but still sufficiently random) RNG
35-
"macro-diagnostics", # Enable better diagnostics for compile-time UUIDs
3634
]
3735
```
3836

src/lib.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,11 @@
107107
//! `borsh`.
108108
//! * `arbitrary` - adds an `Arbitrary` trait implementation to `Uuid` for
109109
//! fuzzing.
110-
//! * `fast-rng` - uses a faster algorithm for generating random UUIDs.
110+
//! * `fast-rng` - uses a faster algorithm for generating random UUIDs when available.
111111
//! This feature requires more dependencies to compile, but is just as suitable for
112112
//! UUIDs as the default algorithm.
113+
//! * `rng-rand` - forces `rand` as the backend for randomness.
114+
//! * `rng-getrandom` - forces `getrandom` as the backend for randomness.
113115
//! * `bytemuck` - adds a `Pod` trait implementation to `Uuid` for byte manipulation
114116
//!
115117
//! # Unstable features
@@ -166,9 +168,9 @@
166168
//! produce random bytes yourself and then pass them to [`Builder::from_random_bytes`]
167169
//! without enabling the `v4` or `v7` features.
168170
//!
169-
//! Versions of `uuid` `1.12` or earlier relied on `getrandom` for randomness, this
170-
//! is no longer guaranteed and configuring `getrandom`'s provider is not guaranteed
171-
//! to make other features relying on randomness work.
171+
//! If you're using `getrandom`, you can specify the `rng-getrandom` or `rng-rand`
172+
//! features of `uuid` and configure `getrandom`'s provider per its docs. `uuid`
173+
//! may upgrade its version of `getrandom` in minor releases.
172174
//!
173175
//! # Examples
174176
//!

0 commit comments

Comments
 (0)