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）来处理和序列化，因此它们内部的值都有与 Deriving Groups 相同的条件，并且从 Deriving Structures 中继承的大部分信息也适用。

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

默认变体

当使用上述枚举时，如果在运行时反序列化不在枚举中的辨别符，您将遇到 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