Borsh in Rust ┃

borsh-rs 是 Borsh 二进制序列化格式的 Rust 实现。

Borsh 代表 哈希二进制对象表示序列化器。它旨在用于安全性关键的项目，因为它优先考虑 一致性、安全性和速度，并附带严格的 规范。

示例

use borsh::{BorshSerialize, BorshDeserialize, from_slice, to_vec};

#[derive(BorshSerialize, BorshDeserialize, PartialEq, Debug)]
struct A {
    x: u64,
    y: String,
}

#[test]
fn test_simple_struct() {
    let a = A {
        x: 3301,
        y: "liber primus".to_string(),
    };
    let encoded_a = to_vec(&a).unwrap();
    let decoded_a = from_slice::<A>(&encoded_a).unwrap();
    assert_eq!(a, decoded_a);
}

功能

从 Serde 中排除可以使得 borsh 具有一些目前 serde 兼容序列化器所不具备的功能。目前我们支持两个功能：borsh(init=<你的初始化方法名称> 和 borsh(skip)（前者在 Serde 中不可用）。

borsh(init=...) 允许在反序列化后自动运行初始化函数。这为那些设计成严格不可变对象的架构增加了许多便利。使用示例

#[derive(BorshSerialize, BorshDeserialize)]
#[borsh(init=init)]
struct Message {
    message: String,
    timestamp: u64,
    public_key: CryptoKey,
    signature: CryptoSignature
    hash: CryptoHash
}

impl Message {
    pub fn init(&mut self) {
        self.hash = CryptoHash::new().write_string(self.message).write_u64(self.timestamp);
        self.signature.verify(self.hash, self.public_key);
    }
}

borsh(skip) 允许跳过序列化/反序列化字段，假设它们实现了 Default 特性，类似于 #[serde(skip)]。

#[derive(BorshSerialize, BorshDeserialize)]
struct A {
    x: u64,
    #[borsh(skip)]
    y: f32,
}

具有显式区分符的枚举

#[borsh(use_discriminant=false|true]) 如果你有具有显式区分符的枚举时是必需的。此设置同时影响 BorshSerialize 和 BorshDeserialize 的行为。

error: You have to specify `#[borsh(use_discriminant=true)]` or `#[borsh(use_discriminant=false)]` for all enums with explicit discriminant

#[derive(BorshDeserialize, BorshSerialize)]
#[borsh(use_discriminant=false)]
enum A {
    X,
    Y = 10,
}