use tdf::prelude::*;

#[derive(TdfSerialize, TdfDeserialize, TdfTyped)]
#[tdf(group, prefix_two)]
pub struct ExampleStructure {
    #[tdf(tag = "TEST")]
    pub my_value: u32
}

警告 当结构被标记为组结构时，您不能将其用作数据包主体，因为它包含表示该结构的额外字节，这可能在其他工具/客户端尝试解析时导致错误

表示枚举

如果您想定义一个枚举，它的值映射到现有的基本类型之一（u8、i8、u16、i16、u32、i32、u64、i64、usize、isize），您可以定义一个repr枚举

注意 Repr 枚举被序列化为变长整数，即 TdfType::VarInt

注意 实现 TdfSerialize 的 Repr 枚举也必须实现 Clone + Copy

use tdf::prelude::*;

#[derive(Clone, Copy, TdfSerialize, TdfDeserialize, TdfTyped)]
#[repr(u8)]
pub enum ExampleReprEnum {
    Test = 0x0,
    Test2 = 0x1,
    Test3 = 0x3
}

别忘了从 TdfTyped 派生以在标签中使用此值

注意 定义 repr 枚举时，您必须使用 #[repr(%TYPE%)]，否则类型将无法识别

警告 与标准 repr 枚举不同，您不能省略每个值的区分符，因为在这个阶段，宏无法推断下一个值。

默认变体

当使用上述枚举时，如果遇到一个在枚举中不存在的区分符，则在运行时会遇到 DecodeError。为了防止这种行为，您可以指定一个默认变体

use tdf::prelude::*;

#[derive(Clone, Copy, TdfSerialize, TdfDeserialize, TdfTyped)]
#[repr(u8)]
pub enum ExampleReprEnum {
    Test = 0x0,
    Test2 = 0x1,
    Test3 = 0x3,
    #[tdf(default)]
    MyDefault = 0x4,
}

标记枚举

您可以使用带有字段的 Rust 枚举来表示 BlazeSDK 标记联合

use tdf::prelude::*;

#[derive(TdfSerialize, TdfDeserialize, TdfTyped)]
pub enum ExampleTaggedEnum {
    #[tdf(key = 0x0, tag = "VALU")]
    Test {
        #[tdf(tag = "TEST")]
        test: String,
    },
    #[tdf(key = 0x1, tag = "VALU")]
    Test2(String)
}

在上面的例子中，每个枚举变体的 "key" 属性是该变体使用的区分符。每个枚举变体的 "tag" 属性是当标记联合的值时使用的标记

在上面的例子中，有一个具有命名字段的变体和一个只有一个未命名字段的变体。

具有命名字段的变体被处理和序列化为组（TdfType::Group），因此它们内部的所有值都具有与 派生组 相同的条件，并且大多数信息也来自 派生结构。

具有未命名字段的变体（您只能指定一个未命名字段，如 ExampleTaggedEnum::Test2 所示）的值被序列化为提供的值的类型，在这种情况下，Test2 将有一个标记为 VALU 的类型为字符串的值。

默认变体

当使用上述枚举，就像在 repr 例子中一样，如果在运行时反序列化了一个不在枚举中出现的区分符，您将遇到 DecodeError。为了防止这种行为，您可以指定一个默认变体

use tdf::prelude::*;

#[derive(TdfSerialize, TdfDeserialize, TdfTyped)]
pub enum ExampleTaggedEnum {
    #[tdf(key = 0x0, tag = "VALU")]
    Test {
        #[tdf(tag = "TEST")]
        test: String,
    },
    #[tdf(key = 0x1, tag = "VALU")]
    Test2(String),

    #[tdf(default)]
    DefaultValue
}

对于实现 TdfSerialize 的标记枚举，如果序列化了默认值，它将使用 unset 区分符

未设置变体

Tdf 标记联合有一个特殊的未设置类型区分符，因此如果反序列化了一个未设置的区分符，则在运行时会遇到 DecodeError。为了防止这种行为，您可以指定一个未设置变体

use tdf::prelude::*;

#[derive(TdfSerialize, TdfDeserialize, TdfTyped)]
pub enum ExampleTaggedEnum {
    #[tdf(key = 0x0, tag = "VALU")]
    Test {
        #[tdf(tag = "TEST")]
        test: String,
    },
    #[tdf(key = 0x1, tag = "VALU")]
    Test2(String),

    #[tdf(unset)]
    Unset
}

注意 您不能将默认变体用作未设置变体，它们必须是分开的，因为默认变体处理可能存在的额外值，这会导致失败

实现 TdfSerialize

请参阅 docs.rs/tdf

实现 TdfDeserialize

请参阅 docs.rs/tdf