@glow-xyz/蜂窝
严格的borsh相容的去/序列器.
目录 生成方式 DocTOC 文档
特征
- 完全可调和,即:.
coption(array(utf8String))已处理 正确的 - 结构可以被嵌入并组成
- 预计算
byteSize无论巢穴多深或多深 - 仅通过提供值或序列化将非固定类型转换为固定版本 数据
- 固定大小和 可修复 结构显示相同的序列化/去序列化API并进行 需要时在引擎盖下转换
- 日志结构配置,包括字节大小以及易于解/串行的任务 诊断
beet:debug struct GameStruct {
beet:debug win: u8 1 B
beet:debug totalWin: u16 2 B
beet:debug whaleAccount: u128 16 B
beet:debug losses: i32 4 B
beet:debug } 23 B +0ms
beet:trace serializing [GameStruct] _GameScore { win: 1, totalWin: 100, whaleAccount: <BN: fffffffffffffffffffffffffffffffb>, losses: -234 } to 23 bytes buffer +0ms
beet:trace deserializing [GameStruct] from 23 bytes buffer +2ms
beet:trace <Buffer 01 64 00 fb ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff 16 ff ff ff> +0ms
beet:trace [
beet:trace 1, 100, 0, 251, 255, 255,
beet:trace 255, 255, 255, 255, 255, 255,
beet:trace 255, 255, 255, 255, 255, 255,
beet:trace 255, 22, 255, 255, 255
beet:trace ] +0ms
固定大小对动态类型
甜菜已经优化了 已固定 类型,因为这可以记录关于 它正在处理的数据结构以及避免缓冲器调整大小.
仅 甜点 已经 已固定 在名称是固定的大小, 所有其他都是 可修复 类型
暴露 toFixedFromData 财务报告和审定财务报表 toFixedFromValue 转换为a的方法 固定甜菜 从
序列数据或数值.
甜菜提供 FixableBeetStruct 将具有非固定大小字段的参数去/序列化.
因此,甜菜执行整个 波斯光谱但是,如果你想要一个图书馆 直接使用其中一种替代品,即:. 波斯语。 。 。 .
API 密码
请找到 API 文件在这里。 。 。 .
实例
单一固定 Struct 配置
import { BeetStruct, i32, u16, u8 } from '@metaplex-foundation/beet'
class Result {
constructor(
readonly win: number,
readonly totalWin: number,
readonly losses: number
) {}
static readonly struct = new BeetStruct<Result>(
[
['win', u8],
['totalWin', u16],
['losses', i32],
],
(args) => new Result(args.win!, args.totalWin!, args.losses!),
'Results'
)
}
单一可修复 Struct 配置
import { FixableBeetStruct, i32, u16, u8, array } from '@metaplex-foundation/beet'
class Result {
constructor(
readonly win: number,
readonly totalWin: number,
readonly losses: number[]
) {}
static readonly struct = new FixableBeetStruct<Result>(
[
['win', u8],
['totalWin', u16],
['losses', array(i32)],
],
(args) => new Result(args.win!, args.totalWin!, args.losses!),
'Results'
)
}
嵌入式 Struct 配置
注: 用途 Result 从上述例子中得出: results 领域 Trader
import { BeetStruct, fixedSizeUtf8String } from '@metaplex-foundation/beet'
class Trader {
constructor(
readonly name: string,
readonly results: Results,
readonly age: number
) {}
static readonly struct = new BeetStruct<Trader>(
[
['name', fixedSizeUtf8String(4)],
['results', Results.struct],
['age', u8],
],
(args) => new Trader(args.name!, args.results!, args.age!),
'Trader'
)
}
const trader = new Trader('bob ', new Results(20, 1200, -455), 22)
const [buf] = Trader.struct.serialize(trader)
const [deserializedTrader] = Trader.struct.deserialize(buf)
直接使用甜菜原创
固定大小
import { u8 } from '@metaplex-foundation/beet'
const n = 1
const buf = Buffer.alloc(u8.byteSize)
u8.write(buf, 0, n)
u8.read(buf, 0) // === 1
动态大小
import { u8, array } from '@metaplex-foundation/beet'
const xs = [ 1, 2 ]
const beet = array(u8)
const fixedBeet = beet.toFixedFromValue(xs)
const buf = Buffer.alloc(fixedBeet.byteSize)
fixedBeet.write(buf, 0, xs)
fixedBeet.read(buf, 0) // === [ 1, 2 ]
直接使用甜菜复合剂
注: 使用情况 Result 从上述例子中划出一个 复合 类型
选项
注: 关于 coption 是一个 可修复 甜菜,因为它的大小不同 有点 文选.
页:1 无 案例.
const resultOption: Beet<COption<Result>> = coption(Result.struct)
const result = new Result(20, 1200, -455)
const fixedBeet = resultOption.toFixedFromValue(result)
const buf = Buffer.alloc(fixedBeet.byteSize)
fixedBeet.write(buf, 0, result)
beet.read(buf, 0) // same as result
阵列
统一固定大小
const resultArray: Beet<Array<Result>> = uniformFixedSizeArray(Result.struct, 3)
const results =[ new Result(20, 1200, -455), new Result(3, 999, 0), new Result(30, 100, -3) ]
const buf = Buffer.alloc(resultArray.byteSize)
beet.write(buf, 0, results)
beet.read(buf, 0) // same as results
动态大小
const resultArray: Beet<Array<Result>> = array(Result.struct)
const results =[ new Result(20, 1200, -455), new Result(3, 999, 0), new Result(30, 100, -3) ]
const fixedBeet = resultsArray.toFixedFromValue(results)
const buf = Buffer.alloc(fixedBeet.byteSize)
fixedBeet.write(buf, 0, results)
fixedBeet.read(buf, 0) // same as results