skrillax-serde-derive

这是一个实现来自skrillax-serde的Serialize、Deserialize和ByteSize的宏，用于给定的类型。有关示例和文档，请查看模块文档。您还可以查看宏测试目录中的测试。

lib.rs:

通常，只需在代码中添加#[derive]（或您需要的任何特质）即可。就像更通用的serdecrate一样，这会处理大多数常见情况，包括不同类型的字段，以及其他结构的引用。但是，有一些需要注意的事项。Silkroad Online数据包不是自描述的，因此我们通常需要提供一些帮助来序列化和反序列化某些类型的数据。通常，您可以通过添加#[silkroad]标签来提供额外的选项。以下章节将解释哪些选项适用于哪些元素。

枚举

枚举通常被序列化为一个字节的区分符，其后是该变体的内容，不包含其他细节。目前，我们不会自动将枚举变体的索引映射到区分符。因此，您需要手动定义一个值。这可以通过使用以下代码来完成：#[silkroad(value = 1)]来设置变体的字节值为1

#[derive(Serialize, Deserialize)]
enum Hello {
    #[silkroad(value = 1)]
    ClientHello(String),
    #[silkroad(value = 2)]
    ServerHello(String)
}

在某些情况下，可能需要区分符为两个字节宽，您可以通过在枚举本身上使用#[silkroad(size = 2)]来指定。

#[derive(Serialize, Deserialize)]
#[silkroad(size = 2)]
enum Hello {
    #[silkroad(value = 0x400D)]
    ClientHello(String)
}

结构体

结构体始终通过序列化和反序列化其字段来进行序列化和反序列化。因此，单元结构体的长度为零。目前还没有选项可以改变结构体的行为，只能改变其字段的行为。

#[derive(Serialize, Deserialize)]
struct Hello(String);

字段

字段之间的序列化和反序列化在结构体和枚举中是相同的。每个字段依次序列化，没有分隔符。因此，需要与消耗的字节数完全匹配。字段按定义的顺序进行序列化和反序列化。

#[derive(Serialize, Deserialize)]
struct Hello {
    one_byte: u8,
    two_bytes: u16
}

集合

集合（例如向量）使用一个字节的长度来编码，然后是集合的元素，没有分隔符。如果大小较大，则需要使用#[silkroad(size = 2)]属性来表示。

#[derive(Serialize, Deserialize)]
struct Hello {
    #[silkroad(size = 2)]
    greetings: Vec<String>
}

默认大小为1，支持的最大大小为4。此外，您可以使用list_type属性更改集合的编码类型。该属性接受三种选项之一：length（默认），break和has-more。break和has-more指定每个元素之前是否还有其他元素，使用不同的值。其中break使用1表示'有更多值'，而2表示完成，而has-more使用1表示还有更多元素，而0表示完成。

#[derive(Serialize, Deserialize)]
struct Hello {
    #[silkroad(list_type = "break")]
    greetings: Vec<String>
}

#[derive(Serialize, Deserialize)]
struct Hello {
    #[silkroad(size = 2)]
    greeting: String
}

#[derive(Serialize)]
struct Hello {
    #[silkroad(size = 0)]
    greeting: Option<String>
}

#[derive(Deserialize, Serialize)]
struct Hello {
    condition: u8
    #[silkroad(when = "condition == 1")]
    greeting: Option<String>
}