newtype-uuid-1.1.3/.cargo_vcs_info.json0000644000000001610000000000100134730ustar { "git": { "sha1": "ef3b5105b628d480d0fc2d64cfc1862aa65685a2" }, "path_in_vcs": "crates/newtype-uuid" }newtype-uuid-1.1.3/CHANGELOG.md000064400000000000000000000045721046102023000141060ustar 00000000000000# Changelog ## [1.1.3] - 2024-11-07 ### Added - Add a `Default` implementation for `TypedUuid`. This implementation resolves to `TypedUuid::nil()`. ## [1.1.2] - 2024-10-07 ### Added More const constructors for typed UUIDs, mirrored from the `uuid` crate: `from_fields`, `from_fields_le`, `from_u128`, `from_u128_le`, `from_u64_pair`, `from_bytes`, and `from_bytes_le`. ### Fixed Correct doc for `as_untyped_uuid`. Thanks [@Dr-Emann](https://github.com/Dr-Emann) for your first contribution! ## [1.1.1] - 2024-10-07 (This version was not released due to a publishing issue.) ## [1.1.0] - 2024-04-12 ### Added - `TypedUuid::nil()` and `max()` constructors. - `TypedUuid` is now `#[repr(transparent)]`. ### Changed - MSRV updated to Rust 1.61. ## [1.0.1] - 2024-02-15 ### Breaking changes - `GenericUuid::to_generic_uuid` has been renamed to `GenericUuid::into_generic_uuid`. ### Changed - Added `#[must_use]` annotations to constructors. ## [1.0.0] - 2024-02-15 (This version was not published due to a CI issue.) ## [0.3.0] - 2024-02-02 ### Breaking changes - `TypedUuidTag::try_new` returns a new `TagError` type rather than just a raw `&'static str`. ### Changed - `TypedUuidTag::as_str` is now a `const fn`. ## [0.2.1] - 2024-02-02 Documentation improvements. ## [0.2.0] - 2024-02-01 ### Breaking changes - `TypedUuidTag`s are now required to be valid ASCII identifiers, with hyphens also supported. ### Misc - Added `#[forbid(unsafe_code)]`. Thanks [Robert Lynch](https://github.com/rob0rt) for the contribution! ## [0.1.0] - 2024-01-30 Initial release. [1.1.3]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-1.1.3 [1.1.2]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-1.1.2 [1.1.1]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-1.1.1 [1.1.0]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-1.1.0 [1.0.1]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-1.0.1 [1.0.0]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-1.0.0 [0.3.0]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-0.3.0 [0.2.1]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-0.2.1 [0.2.0]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-0.2.0 [0.1.0]: https://github.com/oxidecomputer/newtype-uuid/releases/newtype-uuid-0.1.0 newtype-uuid-1.1.3/Cargo.toml0000644000000031360000000000100114760ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2021" rust-version = "1.61" name = "newtype-uuid" version = "1.1.3" build = "build.rs" exclude = [ ".cargo/**/*", ".github/**/*", "scripts/**/*", ] autobins = false autoexamples = false autotests = false autobenches = false description = "Newtype wrapper around UUIDs" documentation = "https://docs.rs/newtype-uuid" readme = "README.md" keywords = [ "uuid", "unique", "guid", "newtype", ] categories = [ "data-structures", "no-std", ] license = "MIT OR Apache-2.0" repository = "https://github.com/oxidecomputer/newtype-uuid" resolver = "2" [package.metadata.docs.rs] all-features = true rustdoc-args = ["--cfg=doc_cfg"] [lib] name = "newtype_uuid" path = "src/lib.rs" [dependencies.schemars] version = "0.8" features = ["uuid1"] optional = true [dependencies.serde] version = "1" features = ["derive"] optional = true [dependencies.uuid] version = "1.7.0" default-features = false [features] alloc = [] default = [ "uuid/default", "std", ] schemars08 = [ "dep:schemars", "std", ] serde = [ "dep:serde", "uuid/serde", ] std = [ "uuid/std", "alloc", ] v4 = ["uuid/v4"] newtype-uuid-1.1.3/Cargo.toml.orig000064400000000000000000000016311046102023000151550ustar 00000000000000[package] name = "newtype-uuid" version = "1.1.3" edition = "2021" license = "MIT OR Apache-2.0" repository = "https://github.com/oxidecomputer/newtype-uuid" description = "Newtype wrapper around UUIDs" documentation = "https://docs.rs/newtype-uuid" readme = "README.md" keywords = ["uuid", "unique", "guid", "newtype"] categories = ["data-structures", "no-std"] rust-version = "1.61" resolver = "2" exclude = [".cargo/**/*", ".github/**/*", "scripts/**/*"] [package.metadata.docs.rs] all-features = true rustdoc-args = ["--cfg=doc_cfg"] [dependencies] serde = { version = "1", optional = true, features = ["derive"] } schemars = { version = "0.8", features = ["uuid1"], optional = true } uuid = { version = "1.7.0", default-features = false } [features] default = ["uuid/default", "std"] std = ["uuid/std", "alloc"] alloc = [] v4 = ["uuid/v4"] serde = ["dep:serde", "uuid/serde"] schemars08 = ["dep:schemars", "std"] newtype-uuid-1.1.3/LICENSE-APACHE000064400000000000000000000251721046102023000142200ustar 00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright (c) 2016 Alex Crichton Copyright (c) 2017 The Tokio Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. newtype-uuid-1.1.3/LICENSE-MIT000064400000000000000000000020521046102023000137200ustar 00000000000000Copyright (c) 2024 Oxide Computer Company Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. newtype-uuid-1.1.3/README.md000064400000000000000000000113151046102023000135450ustar 00000000000000# newtype-uuid [![newtype-uuid on crates.io](https://img.shields.io/crates/v/newtype-uuid)](https://crates.io/crates/newtype-uuid) [![Documentation (latest release)](https://img.shields.io/badge/docs-latest%20version-brightgreen.svg)](https://docs.rs/newtype-uuid) [![Documentation (main)](https://img.shields.io/badge/docs-main-brightgreen)](https://oxidecomputer.github.io/newtype-uuid/rustdoc/newtype_uuid/) [![License](https://img.shields.io/badge/license-Apache-green.svg)](LICENSE-APACHE) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE-MIT) A newtype wrapper around `Uuid`. ## Motivation Many large systems use UUIDs as unique identifiers for various entities. However, the `Uuid` type does not carry information about the kind of entity it identifies, which can lead to mixing up different types of UUIDs at runtime. This crate provides a wrapper type around `Uuid` that allows you to specify the kind of entity the UUID identifies. ## Example ```rust use newtype_uuid::{GenericUuid, TypedUuid, TypedUuidKind, TypedUuidTag}; // First, define a type that represents the kind of UUID this is. enum MyKind {} impl TypedUuidKind for MyKind { fn tag() -> TypedUuidTag { // Tags are required to be ASCII identifiers, with underscores // and dashes also supported. The validity of a tag can be checked // at compile time by assigning it to a const, like so: const TAG: TypedUuidTag = TypedUuidTag::new("my_kind"); TAG } } // Now, a UUID can be created with this kind. let uuid: TypedUuid = "dffc3068-1cd6-47d5-b2f3-636b41b07084".parse().unwrap(); // The Display (and therefore ToString) impls still show the same value. assert_eq!(uuid.to_string(), "dffc3068-1cd6-47d5-b2f3-636b41b07084"); // The Debug impl will show the tag as well. assert_eq!(format!("{:?}", uuid), "dffc3068-1cd6-47d5-b2f3-636b41b07084 (my_kind)"); ``` If you have a large number of UUID kinds, consider defining a macro for your purposes. An example macro: ```rust macro_rules! impl_typed_uuid_kind { ($($kind:ident => $tag:literal),* $(,)?) => { $( pub enum $kind {} impl TypedUuidKind for $kind { #[inline] fn tag() -> TypedUuidTag { const TAG: TypedUuidTag = TypedUuidTag::new($tag); TAG } } )* }; } // Invoke this macro with: impl_typed_uuid_kind! { Kind1 => "kind1", Kind2 => "kind2", } ``` ## Implementations In general, `TypedUuid` uses the same wire and serialization formats as `Uuid`. This means that persistent representations of `TypedUuid` are the same as `Uuid`; `TypedUuid` is intended to be helpful within Rust code, not across serialization boundaries. - The `Display` and `FromStr` impls are forwarded to the underlying `Uuid`. - If the `serde` feature is enabled, `TypedUuid` will serialize and deserialize using the same format as `Uuid`. - If the `schemars08` feature is enabled, `TypedUuid` will implement `JsonSchema` if the corresponding `TypedUuidKind` implements `JsonSchema`. To abstract over typed and untyped UUIDs, the `GenericUuid` trait is provided. This trait also permits conversions between typed and untyped UUIDs. ## Dependencies - The only required dependency is the `uuid` crate. Optional features may add further dependencies. ## Features - `default`: Enables default features in the newtype-uuid crate. - `std`: Enables the use of the standard library. *Enabled by default.* - `serde`: Enables serialization and deserialization support via Serde. *Not enabled by default.* - `v4`: Enables the `new_v4` method for generating UUIDs. *Not enabled by default.* - `schemars08`: Enables support for generating JSON schemas via schemars 0.8. *Not enabled by default.* Note that the format of the generated schema is **not currently part** of the stable API, though we hope to stabilize it in the future. ## Minimum supported Rust version (MSRV) The MSRV of this crate is **Rust 1.60.** In general, this crate will follow the MSRV of the underlying `uuid` crate. Within the 1.x series, MSRV updates will be accompanied by a minor version bump. The MSRVs for each minor version are: * Version **1.0.x**: Rust 1.60. * Version **1.1.x**: Rust 1.61. This permits `TypedUuid` to have `const fn` methods. ## Alternatives - [`typed-uuid`](https://crates.io/crates/typed-uuid): generally similar, but with a few design decisions that are different. ## License This project is available under the terms of either the [Apache 2.0 license](LICENSE-APACHE) or the [MIT license](LICENSE-MIT). newtype-uuid-1.1.3/README.tpl000064400000000000000000000015411046102023000137440ustar 00000000000000# {{crate}} [![newtype-uuid on crates.io](https://img.shields.io/crates/v/newtype-uuid)](https://crates.io/crates/newtype-uuid) [![Documentation (latest release)](https://img.shields.io/badge/docs-latest%20version-brightgreen.svg)](https://docs.rs/newtype-uuid) [![Documentation (main)](https://img.shields.io/badge/docs-main-brightgreen)](https://oxidecomputer.github.io/newtype-uuid/rustdoc/newtype_uuid/) [![License](https://img.shields.io/badge/license-Apache-green.svg)](LICENSE-APACHE) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE-MIT) {{readme}} ## License This project is available under the terms of either the [Apache 2.0 license](LICENSE-APACHE) or the [MIT license](LICENSE-MIT). newtype-uuid-1.1.3/build.rs000064400000000000000000000004421046102023000137320ustar 00000000000000fn main() { // Ideally this would be in the [lints] table in Cargo.toml to avoid a build script, but sadly // the MSRV for that is Rust 1.75. // // TODO: switch to [lints] configuration once the MSRV moves beyond that`. println!("cargo:rustc-check-cfg=cfg(doc_cfg)"); } newtype-uuid-1.1.3/src/lib.rs000064400000000000000000000454611046102023000142020ustar 00000000000000//! A newtype wrapper around [`Uuid`]. //! //! # Motivation //! //! Many large systems use UUIDs as unique identifiers for various entities. However, the [`Uuid`] //! type does not carry information about the kind of entity it identifies, which can lead to mixing //! up different types of UUIDs at runtime. //! //! This crate provides a wrapper type around [`Uuid`] that allows you to specify the kind of entity //! the UUID identifies. //! //! # Example //! //! ```rust //! use newtype_uuid::{GenericUuid, TypedUuid, TypedUuidKind, TypedUuidTag}; //! //! // First, define a type that represents the kind of UUID this is. //! enum MyKind {} //! //! impl TypedUuidKind for MyKind { //! fn tag() -> TypedUuidTag { //! // Tags are required to be ASCII identifiers, with underscores //! // and dashes also supported. The validity of a tag can be checked //! // at compile time by assigning it to a const, like so: //! const TAG: TypedUuidTag = TypedUuidTag::new("my_kind"); //! TAG //! } //! } //! //! // Now, a UUID can be created with this kind. //! let uuid: TypedUuid = "dffc3068-1cd6-47d5-b2f3-636b41b07084".parse().unwrap(); //! //! // The Display (and therefore ToString) impls still show the same value. //! assert_eq!(uuid.to_string(), "dffc3068-1cd6-47d5-b2f3-636b41b07084"); //! //! // The Debug impl will show the tag as well. //! assert_eq!(format!("{:?}", uuid), "dffc3068-1cd6-47d5-b2f3-636b41b07084 (my_kind)"); //! ``` //! //! If you have a large number of UUID kinds, consider defining a macro for your purposes. An //! example macro: //! //! ```rust //! # use newtype_uuid::{TypedUuidKind, TypedUuidTag}; //! macro_rules! impl_typed_uuid_kind { //! ($($kind:ident => $tag:literal),* $(,)?) => { //! $( //! pub enum $kind {} //! //! impl TypedUuidKind for $kind { //! #[inline] //! fn tag() -> TypedUuidTag { //! const TAG: TypedUuidTag = TypedUuidTag::new($tag); //! TAG //! } //! } //! )* //! }; //! } //! //! // Invoke this macro with: //! impl_typed_uuid_kind! { //! Kind1 => "kind1", //! Kind2 => "kind2", //! } //! ``` //! //! # Implementations //! //! In general, [`TypedUuid`] uses the same wire and serialization formats as [`Uuid`]. This means //! that persistent representations of [`TypedUuid`] are the same as [`Uuid`]; [`TypedUuid`] is //! intended to be helpful within Rust code, not across serialization boundaries. //! //! - The `Display` and `FromStr` impls are forwarded to the underlying [`Uuid`]. //! - If the `serde` feature is enabled, `TypedUuid` will serialize and deserialize using the same //! format as [`Uuid`]. //! - If the `schemars08` feature is enabled, [`TypedUuid`] will implement `JsonSchema` if the //! corresponding [`TypedUuidKind`] implements `JsonSchema`. //! //! To abstract over typed and untyped UUIDs, the [`GenericUuid`] trait is provided. This trait also //! permits conversions between typed and untyped UUIDs. //! //! # Dependencies //! //! - The only required dependency is the [`uuid`] crate. Optional features may add further //! dependencies. //! //! # Features //! //! - `default`: Enables default features in the newtype-uuid crate. //! - `std`: Enables the use of the standard library. *Enabled by default.* //! - `serde`: Enables serialization and deserialization support via Serde. *Not enabled by //! default.* //! - `v4`: Enables the `new_v4` method for generating UUIDs. *Not enabled by default.* //! - `schemars08`: Enables support for generating JSON schemas via schemars 0.8. *Not enabled by //! default.* Note that the format of the generated schema is **not currently part** of the stable //! API, though we hope to stabilize it in the future. //! //! # Minimum supported Rust version (MSRV) //! //! The MSRV of this crate is **Rust 1.60.** In general, this crate will follow the MSRV of the //! underlying `uuid` crate. //! //! Within the 1.x series, MSRV updates will be accompanied by a minor version bump. The MSRVs for //! each minor version are: //! //! * Version **1.0.x**: Rust 1.60. //! * Version **1.1.x**: Rust 1.61. This permits `TypedUuid` to have `const fn` methods. //! //! # Alternatives //! //! - [`typed-uuid`](https://crates.io/crates/typed-uuid): generally similar, but with a few design //! decisions that are different. #![forbid(unsafe_code)] #![warn(missing_docs)] #![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(doc_cfg, feature(doc_cfg, doc_auto_cfg))] use core::{ cmp::Ordering, fmt, hash::{Hash, Hasher}, marker::PhantomData, str::FromStr, }; use uuid::Uuid; /// A UUID with type-level information about what it's used for. /// /// For more, see [the library documentation](crate). #[repr(transparent)] #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] #[cfg_attr(feature = "serde", serde(transparent, bound = ""))] pub struct TypedUuid { uuid: Uuid, _phantom: PhantomData, } impl TypedUuid { /// The 'nil UUID' (all zeros). /// /// The nil UUID is a special form of UUID that is specified to have all /// 128 bits set to zero. /// /// # References /// /// * [Nil UUID in RFC4122](https://tools.ietf.org/html/rfc4122.html#section-4.1.7) #[inline] #[must_use] pub const fn nil() -> Self { Self { uuid: Uuid::nil(), _phantom: PhantomData, } } /// The 'max UUID' (all ones). /// /// The max UUID is a special form of UUID that is specified to have all /// 128 bits set to one. /// /// # References /// /// * [Max UUID in Draft RFC: New UUID Formats, Version 4](https://datatracker.ietf.org/doc/html/draft-peabody-dispatch-new-uuid-format-04#section-5.4) #[inline] #[must_use] pub const fn max() -> Self { Self { uuid: Uuid::max(), _phantom: PhantomData, } } /// Creates a UUID from four field values. #[inline] #[must_use] pub const fn from_fields(d1: u32, d2: u16, d3: u16, d4: [u8; 8]) -> Self { Self { uuid: Uuid::from_fields(d1, d2, d3, &d4), _phantom: PhantomData, } } /// Creates a UUID from four field values in little-endian order. /// /// The bytes in the `d1`, `d2` and `d3` fields will be flipped to convert into big-endian /// order. This is based on the endianness of the UUID, rather than the target environment so /// bytes will be flipped on both big and little endian machines. #[inline] #[must_use] pub const fn from_fields_le(d1: u32, d2: u16, d3: u16, d4: [u8; 8]) -> Self { Self { uuid: Uuid::from_fields_le(d1, d2, d3, &d4), _phantom: PhantomData, } } /// Creates a UUID from a 128bit value. #[inline] #[must_use] pub const fn from_u128(value: u128) -> Self { Self { uuid: Uuid::from_u128(value), _phantom: PhantomData, } } /// Creates a UUID from a 128bit value in little-endian order. /// /// The entire value will be flipped to convert into big-endian order. This is based on the /// endianness of the UUID, rather than the target environment so bytes will be flipped on both /// big and little endian machines. #[inline] #[must_use] pub const fn from_u128_le(value: u128) -> Self { Self { uuid: Uuid::from_u128_le(value), _phantom: PhantomData, } } /// Creates a UUID from two 64bit values. #[inline] #[must_use] pub const fn from_u64_pair(d1: u64, d2: u64) -> Self { Self { uuid: Uuid::from_u64_pair(d1, d2), _phantom: PhantomData, } } /// Creates a UUID using the supplied bytes. #[inline] #[must_use] pub const fn from_bytes(bytes: uuid::Bytes) -> Self { Self { uuid: Uuid::from_bytes(bytes), _phantom: PhantomData, } } /// Creates a UUID using the supplied bytes in little-endian order. /// /// The individual fields encoded in the buffer will be flipped. #[inline] #[must_use] pub const fn from_bytes_le(bytes: uuid::Bytes) -> Self { Self { uuid: Uuid::from_bytes_le(bytes), _phantom: PhantomData, } } /// Creates a new, random UUID v4 of this type. #[inline] #[cfg(feature = "v4")] #[must_use] pub fn new_v4() -> Self { Self::from_untyped_uuid(Uuid::new_v4()) } } // --- // Trait impls // --- impl PartialEq for TypedUuid { #[inline] fn eq(&self, other: &Self) -> bool { self.uuid.eq(&other.uuid) } } impl Eq for TypedUuid {} impl PartialOrd for TypedUuid { #[inline] fn partial_cmp(&self, other: &Self) -> Option { Some(self.uuid.cmp(&other.uuid)) } } impl Ord for TypedUuid { #[inline] fn cmp(&self, other: &Self) -> core::cmp::Ordering { self.uuid.cmp(&other.uuid) } } impl Hash for TypedUuid { #[inline] fn hash(&self, state: &mut H) { self.uuid.hash(state); } } impl fmt::Debug for TypedUuid { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.uuid.fmt(f)?; write!(f, " ({})", T::tag()) } } impl fmt::Display for TypedUuid { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.uuid.fmt(f) } } impl Clone for TypedUuid { #[inline] fn clone(&self) -> Self { *self } } impl Copy for TypedUuid {} impl FromStr for TypedUuid { type Err = ParseError; fn from_str(s: &str) -> Result { let uuid = Uuid::from_str(s).map_err(|error| ParseError { error, tag: T::tag(), })?; Ok(Self::from_untyped_uuid(uuid)) } } impl Default for TypedUuid { #[inline] fn default() -> Self { Self::from_untyped_uuid(Uuid::default()) } } #[cfg(feature = "schemars08")] mod schemars08_imp { use super::*; use schemars::JsonSchema; /// Implements `JsonSchema` for `TypedUuid`, if `T` implements `JsonSchema`. /// /// * `schema_name` is set to `"TypedUuidFor"`, concatenated by the schema name of `T`. /// * `schema_id` is set to `format!("newtype_uuid::TypedUuid<{}>", T::schema_id())`. /// * `json_schema` is the same as the one for `Uuid`. impl JsonSchema for TypedUuid where T: TypedUuidKind + JsonSchema, { #[inline] fn schema_name() -> String { format!("TypedUuidFor{}", T::schema_name()) } #[inline] fn schema_id() -> std::borrow::Cow<'static, str> { std::borrow::Cow::Owned(format!("newtype_uuid::TypedUuid<{}>", T::schema_id())) } #[inline] fn json_schema(gen: &mut schemars::gen::SchemaGenerator) -> schemars::schema::Schema { Uuid::json_schema(gen) } } } /// Represents marker types that can be used as a type parameter for [`TypedUuid`]. /// /// Generally, an implementation of this will be a zero-sized type that can never be constructed. An /// empty struct or enum works well for this. /// /// # Implementations /// /// If the `schemars08` feature is enabled, and [`JsonSchema`] is implemented for a kind `T`, then /// [`TypedUuid`]`` will also implement [`JsonSchema`]. /// /// # Notes /// /// If you have a large number of UUID kinds, it can be repetitive to implement this trait for each /// kind. Here's a template for a macro that can help: /// /// ``` /// use newtype_uuid::{TypedUuidKind, TypedUuidTag}; /// /// macro_rules! impl_typed_uuid_kind { /// ($($kind:ident => $tag:literal),* $(,)?) => { /// $( /// pub enum $kind {} /// /// impl TypedUuidKind for $kind { /// #[inline] /// fn tag() -> TypedUuidTag { /// const TAG: TypedUuidTag = TypedUuidTag::new($tag); /// TAG /// } /// } /// )* /// }; /// } /// /// // Invoke this macro with: /// impl_typed_uuid_kind! { /// Kind1 => "kind1", /// Kind2 => "kind2", /// } /// ``` /// /// [`JsonSchema`]: schemars::JsonSchema pub trait TypedUuidKind: Send + Sync + 'static { /// Returns the corresponding tag for this kind. /// /// The tag forms a runtime representation of this type. /// /// The tag is required to be a static string. fn tag() -> TypedUuidTag; } /// Describes what kind of [`TypedUuid`] something is. /// /// This is the runtime equivalent of [`TypedUuidKind`]. #[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)] pub struct TypedUuidTag(&'static str); impl TypedUuidTag { /// Creates a new `TypedUuidTag` from a static string. /// /// The string must be non-empty, and consist of: /// - ASCII letters /// - digits (only after the first character) /// - underscores /// - hyphens (only after the first character) /// /// # Panics /// /// Panics if the above conditions aren't met. Use [`Self::try_new`] to handle errors instead. #[must_use] pub const fn new(tag: &'static str) -> Self { match Self::try_new_impl(tag) { Ok(tag) => tag, Err(message) => panic!("{}", message), } } /// Attempts to create a new `TypedUuidTag` from a static string. /// /// The string must be non-empty, and consist of: /// - ASCII letters /// - digits (only after the first character) /// - underscores /// - hyphens (only after the first character) /// /// # Errors /// /// Returns a [`TagError`] if the above conditions aren't met. pub const fn try_new(tag: &'static str) -> Result { match Self::try_new_impl(tag) { Ok(tag) => Ok(tag), Err(message) => Err(TagError { input: tag, message, }), } } const fn try_new_impl(tag: &'static str) -> Result { if tag.is_empty() { return Err("tag must not be empty"); } let bytes = tag.as_bytes(); if !(bytes[0].is_ascii_alphabetic() || bytes[0] == b'_') { return Err("first character of tag must be an ASCII letter or underscore"); } let mut bytes = match bytes { [_, rest @ ..] => rest, [] => panic!("already checked that it's non-empty"), }; while let [rest @ .., last] = &bytes { if !(last.is_ascii_alphanumeric() || *last == b'_' || *last == b'-') { break; } bytes = rest; } if !bytes.is_empty() { return Err("tag must only contain ASCII letters, digits, underscores, or hyphens"); } Ok(Self(tag)) } /// Returns the tag as a string. pub const fn as_str(&self) -> &'static str { self.0 } } impl fmt::Display for TypedUuidTag { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.write_str(self.0) } } impl AsRef for TypedUuidTag { fn as_ref(&self) -> &str { self.0 } } /// An error that occurred while creating a [`TypedUuidTag`]. #[derive(Clone, Debug)] #[non_exhaustive] pub struct TagError { /// The input string. pub input: &'static str, /// The error message. pub message: &'static str, } impl fmt::Display for TagError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!( f, "error creating tag from '{}': {}", self.input, self.message ) } } #[cfg(feature = "std")] impl std::error::Error for TagError {} /// An error that occurred while parsing a [`TypedUuid`]. #[derive(Clone, Debug)] #[non_exhaustive] pub struct ParseError { /// The underlying error. pub error: uuid::Error, /// The tag of the UUID that failed to parse. pub tag: TypedUuidTag, } impl fmt::Display for ParseError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "error parsing UUID ({})", self.tag) } } #[cfg(feature = "std")] impl std::error::Error for ParseError { fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { Some(&self.error) } } /// A trait abstracting over typed and untyped UUIDs. /// /// This can be used to write code that's generic over [`TypedUuid`], [`Uuid`], and other types that /// may wrap [`TypedUuid`] (due to e.g. orphan rules). /// /// This trait is similar to `From`, but a bit harder to get wrong -- in general, the conversion /// from and to untyped UUIDs should be careful and explicit. pub trait GenericUuid { /// Creates a new instance of `Self` from an untyped [`Uuid`]. #[must_use] fn from_untyped_uuid(uuid: Uuid) -> Self where Self: Sized; /// Converts `self` into an untyped [`Uuid`]. #[must_use] fn into_untyped_uuid(self) -> Uuid where Self: Sized; /// Returns the inner [`Uuid`]. /// /// Generally, [`into_untyped_uuid`](Self::into_untyped_uuid) should be preferred. However, /// in some cases it may be necessary to use this method to satisfy lifetime constraints. fn as_untyped_uuid(&self) -> &Uuid; } impl GenericUuid for Uuid { #[inline] fn from_untyped_uuid(uuid: Uuid) -> Self { uuid } #[inline] fn into_untyped_uuid(self) -> Uuid { self } #[inline] fn as_untyped_uuid(&self) -> &Uuid { self } } impl GenericUuid for TypedUuid { #[inline] fn from_untyped_uuid(uuid: Uuid) -> Self { Self { uuid, _phantom: PhantomData, } } #[inline] fn into_untyped_uuid(self) -> Uuid { self.uuid } #[inline] fn as_untyped_uuid(&self) -> &Uuid { &self.uuid } } #[cfg(test)] mod tests { use super::*; #[test] fn test_validate_tags() { for &valid_tag in &[ "a", "a-", "a_", "a-b", "a_b", "a1", "a1-", "a1_", "a1-b", "a1_b", "_a", ] { TypedUuidTag::try_new(valid_tag).expect("tag is valid"); // Should not panic _ = TypedUuidTag::new(valid_tag); } for invalid_tag in &["", "1", "-", "a1b!", "a1-b!", "a1_b:", "\u{1f4a9}"] { TypedUuidTag::try_new(invalid_tag).unwrap_err(); } } // This test just ensures that `GenericUuid` is object-safe. #[test] #[cfg(all(feature = "v4", feature = "std"))] fn test_generic_uuid_object_safe() { let uuid = Uuid::new_v4(); let box_uuid = Box::new(uuid) as Box; assert_eq!(box_uuid.as_untyped_uuid(), &uuid); } }