Releases: uuid-rs/uuid
1.3.1
What's Changed
- Update syn requirement from 1.0.80 to 2.0.5 by @dependabot in #663
- Update windows-sys requirement from 0.45.0 to 0.48.0 by @dependabot in #665
- remove some extra chars in a comment by @KodrAus in #666
- Prepare for 1.3.1 release by @KodrAus in #667
Full Changelog: 1.3.0...1.3.1
Contributors
Assets 2
1.3.0
What's Changed
- Fix error message. by @basbossink-ds in #656
- implement Arbitrary::size_hint by @Ekleog in #657
- Always use hyphenated format regardless of flags by @KodrAus in #658
- Update windows-sys requirement from 0.42.0 to 0.45.0 by @dependabot in #654
- Prepare for 1.3.0 release by @KodrAus in #659
New Contributors
- @basbossink-ds made their first contribution in #656
- @Ekleog made their first contribution in #657
Full Changelog: 1.2.2...1.3.0
Contributors
Assets 2
1.2.2
1.2.1
1.2.0
What's Changed
- formatting changes by @pintariching in #610
- Remove outdated Travis CI reference by @atouchet in #616
- refactors Timestamp, Context and ClockSequence, and adds UUIDS v6, v7, v8 by @rrichardson in #611
- migrate from winapi to windows_sys in examples by @sn99 in #626
- Update windows-sys requirement from 0.36.1 to 0.42.0 by @dependabot in #628
- Some work on the new version features by @KodrAus in #625
- Implement now in wasm by @KodrAus in #630
- More work on docs by @KodrAus in #631
- hide draft versions behind the unstable cfg by @KodrAus in #633
- Prepare for 1.2.0 release by @KodrAus in #634
New Contributors
- @pintariching made their first contribution in #610
- @atouchet made their first contribution in #616
- @sn99 made their first contribution in #626
Full Changelog: 1.1.2...1.2.0
Contributors
Assets 2
1.1.2
1.1.1
1.1.0
Contributors
Assets 2
1.0.0
This release includes a huge amount of work from a lot of contributors. These notes are duplicated from 1.0.0-alpha.1 since they're relevant for anybody moving from 0.8.2 to 1.0.0.
Changes since the last release
Contributions since the last release
- #510
- #482
- #511
- #507
- #518
- #519
- #512
- #520
- #521
- #525
- #526
- #527
- #528
- #535
- #536
- #539
- #538
- #540
- #541
- #542
- #544
- #545
- #546
- #543
- #547
- #548
- #549
- #550
- #552
- #554
- #558
- #560
- #562
- #563
- #564
- #565
- #566
- #579
- #584
- #587
- #595
@Gaelan @hecsalazarf @Expyron @saiintbrisson @tshepang @Tehnix @Takashiidobe @A248 @clehner
With a special thanks to:
@kinggoesgaming @QnnOkabayashi @Nugine
Highlights
Parsing and formatting methods are now much faster, and work in const too! On my i9 9900K Windows desktop, the difference looks something like this:
| Case | 1.0.0-alpha.1 |
0.8.3 |
|---|---|---|
| parse_invalid_character | 40 ns/iter (+/- 0) | 39 ns/iter (+/- 1) |
| parse_invalid_group_len | 47 ns/iter (+/- 1) | 52 ns/iter (+/- 5) |
| parse_invalid_groups | 58 ns/iter (+/- 1) | 58 ns/iter (+/- 0) |
| parse_invalid_len | 57 ns/iter (+/- 2) | 6 ns/iter (+/- 0) |
| parse_nil | 16 ns/iter (+/- 0) | 50 ns/iter (+/- 4) |
| parse_nil_hyphenated | 17 ns/iter (+/- 0) | 59 ns/iter (+/- 2) |
| parse_random | 16 ns/iter (+/- 0) | 42 ns/iter (+/- 1) |
| parse_random_hyphenated | 18 ns/iter (+/- 0) | 51 ns/iter (+/- 2) |
| parse_urn | 18 ns/iter (+/- 0) | 51 ns/iter (+/- 1) |
You can go one step further and look at the uuid-simd library for vectorized UUID parsing. It's fast!
You can create UUIDs at compile time using the uuid! macro:
#[macro_use]
extern crate uuid;
use uuid::Uuid;
const ID: Uuid = uuid!("67e55044-10b1-426f-9247-bb680e5fe0c8");Enable the macro-diagnostics crate feature to get better diagnostics from uuid! using a procedural macro.
Breaking changes
Relocation of adapter::compact
This module can now be found in serde::compact. It can be combined with #[serde(with)] to serialize a Uuid using a more compact representation. We originally moved to this representation directly, but discovered it comes with its own drawbacks that aren't suitable for all formats.
Infallible constructors
The following methods have been changed to accept a &[u8; N] instead of a &[u8], making them infallible instead of returning a Result:
Uuid::from_fieldsUuid::from_fields_leUuid::new_v1Builder::from_fieldsBuilder::from_fields_le
Infallible get_variant
The Uuid::get_variant method now returns a Variant instead of an Option<Varaint>, because it's not actually possible for it to ever be None.
Uuid::to_timestamp is now Uuid::get_timestamp
The Uuid::to_timestamp method has been renamed to Uuid::get_timestamp to make it more consistent with Uuid::get_version and Uuid::get_variant.
Changes to formatting methods
The following methods that produce formatting adapters have been renamed:
Uuid::to_hyphenated->Uuid::hyphenatedUuid::to_simple->Uuid::simpleUuid::to_urn->Uuid::urn
The following types have been removed:
HyphenatedRefSimpleRefUrnRef
The following methods have been changed to return a &<AdapterType> instead of an <AtapterType>Ref:
Uuid::to_hyphenated_ref->Uuid::as_hyphenatedUuid::to_simple_ref->Uuid::as_simpleUuid::to_urn_ref->Uuid::as_urn
Builder method consistency
The Builder::build method has been renamed to Builder::into_uuid, to complement the <AdapterType>::into_uuid methods. It also gets an equivalent Builder::as_uuid method.
Version and Variant are non-exhaustive
The #[non_exhaustive] attribute has been added to Version and Variant. There are already active proposals for new UUID versions, so these are likely to continue evolving in the future.
Removed winapi support
The Uuid::to_guid and Uuid::from_guid methods have been removed. This was done for two reasons:
- We need to avoid unstable
winapitypes in the stableuuidpublic API. - Whether or not GUID fields need to be flipped to convert into a UUID depends on the source of the GUID, so we can't really offer a single pair of methods to convert a GUID into a UUID.
There are some examples in the repository root that demonstrate how to convert GUIDs into UUIDs as a replacement.
Building with --all-features
Now that uuid includes unstable features, if you're building with --all-features (such as in package manager scenarios), you'll also need to pass RUSTFLAGS="--cfg uuid_unstable", or you'll end up with compilation errors. If this strategy becomes problematic for users we can change unstable features to silently no-op instead of cause compilation failures if the corresponding cfg is not also supplied. Please reach out if that affects you!
Stability commitment
With uuid 1.0 we'll try to stay on that version "forever". There won't be a 2.0 unless there's a very compelling need for it. That means you should feel safe depending on Uuid in the public API of your libraries if you want to.
Contributors
Assets 2
1.0.0-alpha.1
This release includes a huge amount of work from a lot of contributors. I'll try call out breakage here as well as in release notes once we're ready to merge so everyone knows what to expect.
Changes since the last release
Contributions since the last release
- #510
- #482
- #511
- #507
- #518
- #519
- #512
- #520
- #521
- #525
- #526
- #527
- #528
- #535
- #536
- #539
- #538
- #540
- #541
- #542
- #544
- #545
- #546
- #543
- #547
- #548
- #549
- #550
- #552
- #554
- #558
- #560
- #562
- #563
- #564
- #565
- #566
@Gaelan @hecsalazarf @Expyron @saiintbrisson @tshepang @Tehnix @Takashiidobe
With a special thanks to:
@kinggoesgaming @QnnOkabayashi @Nugine
Highlights
Parsing and formatting methods are now much faster, and work in const too! On my i9 9900K Windows desktop, the difference looks something like this:
| Case | 1.0.0-alpha.1 |
0.8.3 |
|---|---|---|
| parse_invalid_character | 40 ns/iter (+/- 0) | 39 ns/iter (+/- 1) |
| parse_invalid_group_len | 47 ns/iter (+/- 1) | 52 ns/iter (+/- 5) |
| parse_invalid_groups | 58 ns/iter (+/- 1) | 58 ns/iter (+/- 0) |
| parse_invalid_len | 57 ns/iter (+/- 2) | 6 ns/iter (+/- 0) |
| parse_nil | 16 ns/iter (+/- 0) | 50 ns/iter (+/- 4) |
| parse_nil_hyphenated | 17 ns/iter (+/- 0) | 59 ns/iter (+/- 2) |
| parse_random | 16 ns/iter (+/- 0) | 42 ns/iter (+/- 1) |
| parse_random_hyphenated | 18 ns/iter (+/- 0) | 51 ns/iter (+/- 2) |
| parse_urn | 18 ns/iter (+/- 0) | 51 ns/iter (+/- 1) |
You can go one step further and look at the uuid-simd library for vectorized UUID parsing. It's fast!
You can create UUIDs at compile time using the uuid! macro:
#[macro_use]
extern crate uuid;
use uuid::Uuid;
const ID: Uuid = uuid!("67e55044-10b1-426f-9247-bb680e5fe0c8");Enable the macro-diagnostics crate feature to get better diagnostics from uuid! using a procedural macro.
Breaking changes
Relocation of adapter::compact
This module can now be found in serde::compact. It can be combined with #[serde(with)] to serialize a Uuid using a more compact representation. We originally moved to this representation directly, but discovered it comes with its own drawbacks that aren't suitable for all formats.
Infallible constructors
The following methods have been changed to accept a &[u8; N] instead of a &[u8], making them infallible instead of returning a Result:
Uuid::from_fieldsUuid::from_fields_leUuid::new_v1Builder::from_fieldsBuilder::from_fields_le
Infallible get_variant
The Uuid::get_variant method now returns a Variant instead of an Option<Varaint>, because it's not actually possible for it to ever be None.
Uuid::to_timestamp is now Uuid::get_timestamp
The Uuid::to_timestamp method has been renamed to Uuid::get_timestamp to make it more consistent with Uuid::get_version and Uuid::get_variant.
Changes to formatting methods
The following methods that produce formatting adapters have been renamed:
Uuid::to_hyphenated->Uuid::hyphenatedUuid::to_simple->Uuid::simpleUuid::to_urn->Uuid::urn
The following types have been removed:
HyphenatedRefSimpleRefUrnRef
The following methods have been changed to return a &<AdapterType> instead of an <AtapterType>Ref:
Uuid::to_hyphenated_ref->Uuid::as_hyphenatedUuid::to_simple_ref->Uuid::as_simpleUuid::to_urn_ref->Uuid::as_urn
Builder method consistency
The Builder::build method has been renamed to Builder::into_uuid, to complement the <AdapterType>::into_uuid methods. It also gets an equivalent Builder::as_uuid method.
Version and Variant are non-exhaustive
The #[non_exhaustive] attribute has been added to Version and Variant. There are already active proposals for new UUID versions, so these are likely to continue evolving in the future.
Removed winapi support
The Uuid::to_guid and Uuid::from_guid methods have been removed. This was done for two reasons:
- We need to avoid unstable
winapitypes in the stableuuidpublic API. - Whether or not GUID fields need to be flipped to convert into a UUID depends on the source of the GUID, so we can't really offer a single pair of methods to convert a GUID into a UUID.
There are some examples in the repository root that demonstrate how to convert GUIDs into UUIDs as a replacement.
Building with --all-features
Now that uuid includes unstable features, if you're building with --all-features (such as in package manager scenarios), you'll also need to pass RUSTFLAGS="--cfg uuid_unstable", or you'll end up with compilation errors. If this strategy becomes problematic for users we can change unstable features to silently no-op instead of cause compilation failures if the corresponding cfg is not also supplied. Please reach out if that affects you!
Stability commitment
Once uuid releases 1.0 we'll try to stay on that version "forever". There won't be a 2.0 unless there's a very compelling need for it. That means you should feel safe depending on Uuid in the public API of your libraries if you want to.