enumcapsulate-macros

为 enumcapsulate 包提供派生宏。

宏

enumcapsulate-macros 进程宏包导出以下派生宏

宏辅助属性

大多数 derive 宏支持辅助属性

#[enumcapsulate(exclude)]

该 crate 中的基于变体的 derive 宏将对枚举中找到的每个单字段变体执行 derive。这可能导致不期望的误报，其中像 ToBeExcluded 这样的变体无意中被检测为 bool 类型的变体。

给定如下枚举 …

struct VariantA {
    // ...
}

struct VariantB {
    // ...
}

#[derive(FromVariant)]
enum Enum {
    VariantA(VariantA),
    VariantB(VariantB),
    ToBeExcluded { flagToBeExcluded: bool },
}

… 以下实现将从上述代码中推导出来

impl FromVariant<VariantA> for Enum {
    // ...
}

impl FromVariant<VariantB> for Enum {
    // ...
}

// Notice how the derive picked up the `is_cool: bool` field
// as an inner variant and generated an impl for it:

impl FromVariant<bool> for Enum {
    // ...
}

将 #[enumcapsulate(exclude)] 添加到不期望的变体 …

#[derive(FromVariant)]
enum Enum {
    // ...
    #[enumcapsulate(exclude)]
    ToBeExcluded { flag: bool },
}

… 使得不期望的 impl FromVariant<bool> for Enum 被省略。

#[enumcapsulate(include(field=…_)]

该 crate 中的基于变体的 derive 宏将跳过对枚举中找到的任何多字段变体的 derive。

这可能导致不期望的误判，其中像 ToBeIncluded 这样的变体无意中被检测为 bool 类型的变体。

对于元组变体，字段可以通过其索引指定： #[enumcapsulate(include(field = INDEX))] 对于结构体变体，字段可以通过其名称指定： #[enumcapsulate(include(field = "NAME"))]

给定如下枚举 …

struct VariantA {
    // ...
}

struct VariantB {
    // ...
}

struct VariantC {
    // ...
}

#[derive(FromVariant)]
enum Enum {
    VariantA(VariantA),
    ToBeIncludedB(bool, VariantB),
    ToBeIncludedC { flag: bool, variant: VariantC },
}

… 以下实现将从上述代码中推导出来

impl FromVariant<VariantA> for Enum {
    // ...
}

// Notice how the variants `ToBeIncludedB { … }` and `ToBeIncludedC { … }`
// produced no impls, due to having more than one field.

将 #[enumcapsulate(include(field = …))] 添加到所需的变体，并指定所需的变体字段 …

#[derive(FromVariant)]
enum Enum {
    // ...
    #[enumcapsulate(include(field = 1))]
    ToBeIncludedB(bool, VariantB),
    #[enumcapsulate(include(field = "variant"))]
    ToBeIncludedC { flag: bool, variant: VariantC },
}

// ...

impl FromVariant<VariantB> for Enum {
    // ...
}

impl FromVariant<VariantC> for Enum {
    // ...
}