newtype-uuid

围绕 Uuid 的新类型包装器。

动机

许多大型系统使用UUID作为各种实体的唯一标识符。然而，Uuid 类型不携带其标识实体类型的任何信息，这可能导致在运行时混淆不同类型的UUID。

此crate提供了一个围绕 Uuid 的包装器类型，允许您指定UUID标识的实体类型。

示例

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<MyKind> = "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)");

如果您有许多UUID类型，考虑为您的目的定义一个宏。一个示例宏

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",
}

实现

通常，TypedUuid 使用与 Uuid 相同的线缆和序列化格式。这意味着 TypedUuid 的持久表示与 Uuid 相同；TypedUuid 的目的是在Rust代码中提供帮助，而不是在序列化边界之外。

• Display 和 FromStr 实现被转发到底层的 Uuid。
• 如果启用了 serde 功能，则 TypedUuid 将使用与 Uuid 相同的格式进行序列化和反序列化。
• 如果启用了 schemars08 功能，则如果相应的 TypedUuidKind 实现了 JsonSchema，则 TypedUuid 将实现 JsonSchema。

为了抽象类型和未类型化的UUID，提供了 GenericUuid trait。此trait还允许在类型化和未类型化的UUID之间进行转换。

依赖关系

• 唯一必需的依赖关系是 uuid crate。可选功能可能会添加额外的依赖关系。

功能

• default：在uuid crate中启用默认功能。
• std：启用标准库的使用。 默认启用。
• serde：通过Serde启用序列化和反序列化支持。 默认未启用。
• v4：启用生成UUID的 new_v4 方法。 默认未启用。
• schemars08：启用通过schemars 0.8生成JSON模式的支持。默认不启用。请注意，生成的模式格式目前不是稳定API的一部分，尽管我们希望在未来将其稳定下来。

最低支持的Rust版本（MSRV）

此crate的MSRV是Rust 1.60。通常，此crate将遵循底层uuid crate的MSRV。

在1.x系列中，MSRV更新将伴随小版本号的增加。每个小版本的MSRV如下

• 版本1.0.x：Rust 1.60

替代方案

• typed-uuid：通常类似，但有一些设计决策不同。

许可协议

此项目可在Apache 2.0许可协议或MIT许可协议下使用。