itsscb/uuid
1
0
Fork 0
mirror of https://github.com/uuid-rs/uuid.git synced 2025-09-29 22:10:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

merging in ci changes and doc fixes from kodraus

Browse Source
This commit is contained in:
Rick Richardson 2022-08-25 14:51:02 -07:00
commit 70d71aace0
No known key found for this signature in database
GPG Key ID: 9FB06D29B7C22B54
5 changed files with 43 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
.github/workflows/ci.yml vendored
View File

@ -1,5 +1,9 @@
name: Continuous integration
env:
VERSION_FEATURES: "v1 v3 v4 v5"
STABLE_DEP_FEATURES: "serde arbitrary"
on:
pull_request:
push:
@ -61,8 +65,11 @@ jobs:
- name: Examples
run: cargo test --all-features --examples
- name: Powerset
run: cargo hack test --feature-powerset --lib --optional-deps "serde arbitrary" --depth 3
- name: Each version feature
run: cargo hack test --lib --each-feature --optional-deps $STABLE_DEP_FEATURES
- name: All version features
run: cargo hack test --lib --features "$VERSION_FEATURES" --each-feature --optional-deps "$STABLE_DEP_FEATURES"
msrv:
name: "Tests / MSRV / OS: ${{ matrix.os }}"
@ -86,7 +93,7 @@ jobs:
override: true
- name: Version features
run: cargo test --features "v1 v3 v4 v5 serde"
run: cargo test --features "$VERSION_FEATURES $STABLE_DEP_FEATURES"
wasm:
name: Tests / WebAssembly
@ -102,7 +109,7 @@ jobs:
run: wasm-pack test --node
- name: Version features
run: wasm-pack test --node -- --features "js v1 v3 v4 v5"
run: wasm-pack test --node -- --features "$VERION_FEATURES $STABLE_DEP_FEATURES js"
- name: Fast RNG
run: wasm-pack test --node -- --features "js v4 fast-rng"
@ -174,4 +181,4 @@ jobs:
run: cargo install cargo-hack
- name: Powerset
run: cargo hack check --feature-powerset -Z avoid-dev-deps
run: cargo hack check --each-feature -Z avoid-dev-deps

11
Cargo.toml
View File

@ -51,13 +51,14 @@ repository = "uuid-rs/uuid"
default = ["std"]
std = []
macro-diagnostics = ["private_uuid-macro-internal"]
# NOTE: When adding new features, check the `ci.yml` workflow
# and include them where necessary (you can follow along with existing features)
v1 = ["private_atomic"]
v3 = ["md5"]
v4 = ["rng"]
v5 = ["sha1"]
v6 = ["private_atomic"]
v7 = ["rng"]
v8 = []
js = ["private_getrandom", "private_getrandom/js"]
rng = ["private_getrandom"]
@ -85,7 +86,7 @@ version = "1"
# Public (unstable): Used in `zerocopy` derive
# Unstable: also need RUSTFLAGS="--cfg uuid_unstable" to work
# This feature may break between releases, or be removed entirely before
# stabilization.
# stabilization.
# See: https://github.com/uuid-rs/uuid/issues/588
[dependencies.zerocopy]
optional = true
@ -134,6 +135,8 @@ version = "1.1.2"
path = "macros"
optional = true
# Private
# Don't depend on this optional feature directly: it may change at any time
[dependencies.private_atomic]
package = "atomic"
default-features = false

16
src/builder.rs
View File

@ -307,7 +307,7 @@ impl Uuid {
/// Basic usage:
///
/// ```
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// # use uuid::Uuid;
/// let bytes = [
/// 0xa1, 0xa2, 0xa3, 0xa4,
@ -348,7 +348,7 @@ impl Uuid {
/// Basic usage:
///
/// ```
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// # use uuid::Uuid;
/// let bytes = [
/// 0xa1, 0xa2, 0xa3, 0xa4,
@ -383,7 +383,7 @@ impl Uuid {
/// Basic usage:
///
/// ```
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// # use uuid::Uuid;
/// let bytes = [
/// 0xa1, 0xa2, 0xa3, 0xa4,
@ -414,7 +414,7 @@ impl Uuid {
/// Basic usage:
///
/// ```
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// # use uuid::Uuid;
/// let bytes = [
/// 0xa1, 0xa2, 0xa3, 0xa4,
@ -446,7 +446,7 @@ impl Uuid {
/// Basic usage:
///
/// ```
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// # use uuid::Uuid;
/// let bytes = [
/// 0xa1, 0xa2, 0xa3, 0xa4,
@ -515,7 +515,7 @@ impl Builder {
/// Basic usage:
///
/// ```
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// # use uuid::{Builder, Uuid};
/// let bytes = [
/// 0xa1, 0xa2, 0xa3, 0xa4,
@ -589,7 +589,7 @@ impl Builder {
///
/// ```
/// # use uuid::Builder;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let bytes = [
/// 0xa1, 0xa2, 0xa3, 0xa4,
/// 0xb1, 0xb2,
@ -624,7 +624,7 @@ impl Builder {
///
/// ```
/// # use uuid::Builder;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let bytes = [
/// 0xa1, 0xa2, 0xa3, 0xa4,
/// 0xb1, 0xb2,

26
src/lib.rs
View File

@ -157,7 +157,7 @@
//!
//! ```
//! # use uuid::Uuid;
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! # fn main() -> Result<(), uuid::Error> {
//! let my_uuid = Uuid::parse_str("a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8")?;
//!
//! println!("{}", my_uuid.urn());
@ -326,7 +326,7 @@ pub enum Variant {
///
/// ```
/// # use uuid::Uuid;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let my_uuid = Uuid::parse_str("a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8")?;
///
/// println!("{}", my_uuid.urn());
@ -363,7 +363,7 @@ pub enum Variant {
///
/// ```
/// # use uuid::Uuid;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let my_uuid = Uuid::parse_str("a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8")?;
///
/// assert_eq!(
@ -378,7 +378,7 @@ pub enum Variant {
///
/// ```
/// # use uuid::Uuid;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let my_uuid = Uuid::parse_str("a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8")?;
///
/// assert_eq!(
@ -454,7 +454,7 @@ impl Uuid {
///
/// ```
/// # use uuid::{Uuid, Variant};
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let my_uuid = Uuid::parse_str("02f09a3f-1624-3b1d-8409-44eff7708208")?;
///
/// assert_eq!(Variant::RFC4122, my_uuid.get_variant());
@ -489,7 +489,7 @@ impl Uuid {
///
/// ```
/// # use uuid::Uuid;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let my_uuid = Uuid::parse_str("02f09a3f-1624-3b1d-8409-44eff7708208")?;
///
/// assert_eq!(3, my_uuid.get_version_num());
@ -519,7 +519,7 @@ impl Uuid {
///
/// ```
/// # use uuid::{Uuid, Version};
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let my_uuid = Uuid::parse_str("02f09a3f-1624-3b1d-8409-44eff7708208")?;
///
/// assert_eq!(Some(Version::Md5), my_uuid.get_version());
@ -569,7 +569,7 @@ impl Uuid {
///
/// ```
/// # use uuid::Uuid;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let uuid = Uuid::nil();
///
/// assert_eq!(uuid.as_fields(), (0, 0, 0, &[0u8; 8]));
@ -616,7 +616,7 @@ impl Uuid {
/// ```
/// use uuid::Uuid;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let uuid = Uuid::parse_str("a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8")?;
///
/// assert_eq!(
@ -653,7 +653,7 @@ impl Uuid {
///
/// ```
/// # use uuid::Uuid;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let uuid = Uuid::parse_str("a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8")?;
///
/// assert_eq!(
@ -697,7 +697,7 @@ impl Uuid {
///
/// ```
/// # use uuid::Uuid;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let uuid = Uuid::parse_str("a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8")?;
///
/// assert_eq!(
@ -736,7 +736,7 @@ impl Uuid {
///
/// ```
/// # use uuid::Uuid;
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let uuid = Uuid::parse_str("a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8")?;
/// assert_eq!(
/// uuid.as_u64_pair(),
@ -810,7 +810,7 @@ impl Uuid {
/// ```
/// use uuid::Uuid;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let uuid = Uuid::parse_str("a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8")?;
///
/// assert_eq!(

6
src/parser.rs
View File

@ -51,7 +51,7 @@ impl Uuid {
///
/// ```
/// # use uuid::{Uuid, Version, Variant};
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let uuid = Uuid::parse_str("550e8400-e29b-41d4-a716-446655440000")?;
///
/// assert_eq!(Some(Version::Random), uuid.get_version());
@ -84,7 +84,7 @@ impl Uuid {
///
/// ```
/// # use uuid::{Uuid, Version, Variant};
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let uuid = Uuid::try_parse("550e8400-e29b-41d4-a716-446655440000")?;
///
/// assert_eq!(Some(Version::Random), uuid.get_version());
@ -112,7 +112,7 @@ impl Uuid {
///
/// ```
/// # use uuid::{Uuid, Version, Variant};
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn main() -> Result<(), uuid::Error> {
/// let uuid = Uuid::try_parse_ascii(b"550e8400-e29b-41d4-a716-446655440000")?;
///
/// assert_eq!(Some(Version::Random), uuid.get_version());