vb 0.2.7

The fastest VByte/Varint encoding library in Rust / Rust 生态最快的变长字节编码库
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

#!/usr/bin/env bun

import { readFileSync, writeFileSync } from "fs";
import { join } from "path";
import { execSync } from "child_process";
import os from "os";
import Table from "cli-table3";

const ROOT = import.meta.dirname;
const JSON_PATH = join(ROOT, "bench.json");
const EN_MD = join(ROOT, "readme/en.bench.md");
const ZH_MD = join(ROOT, "readme/zh.bench.md");

const getSystemInfo = () => {
  const cpus = os.cpus();
  const cpu = cpus[0]?.model || "Unknown";
  const cores = cpus.length;
  const mem = (os.totalmem() / 1024 / 1024 / 1024).toFixed(1);
  const platform = os.platform();
  const arch = os.arch();

  let rustVer = "Unknown";
  try {
    rustVer = execSync("rustc --version", { encoding: "utf8" }).trim();
  } catch {}

  let osName = `${platform}`;
  if (platform === "darwin") {
    try {
      const ver = execSync("sw_vers -productVersion", { encoding: "utf8" }).trim();
      osName = `macOS ${ver}`;
    } catch {}
  }

  return { cpu, cores, mem, osName, arch, rustVer };
};

const printConsoleTable = (results, dataCount) => {
  const table = new Table({
    head: ["Library", "Encode (M/s)", "Decode (M/s)"],
    style: { head: ["cyan"] },
  });

  for (const r of results) {
    const encThroughput = ((dataCount / r.encode_ns) * 1e9 / 1e6).toFixed(1);
    const decThroughput = ((dataCount / r.decode_ns) * 1e9 / 1e6).toFixed(1);
    table.push([r.lib, encThroughput, decThroughput]);
  }

  console.log(`\nVByte Benchmark Results (${dataCount.toLocaleString()} integers):`);
  console.log(table.toString());
};

const genMdEn = (data, sys) => {
  const { results, data_count } = data;
  const lines = [];

  lines.push("## VByte Encoding Benchmark\n");
  lines.push(`Comparing varint encoding libraries with ${data_count.toLocaleString()} integers (mixed distribution: 60% small, 30% medium, 10% large).\n`);

  lines.push("### Results\n");
  lines.push("| Library | Encode (M/s) | Decode (M/s) |");
  lines.push("|---------|--------------|--------------|");

  for (const r of results) {
    const encThroughput = ((data_count / r.encode_ns) * 1e9 / 1e6).toFixed(1);
    const decThroughput = ((data_count / r.decode_ns) * 1e9 / 1e6).toFixed(1);
    lines.push(`| ${r.lib} | ${encThroughput} | ${decThroughput} |`);
  }
  lines.push("");

  lines.push("### Environment\n");
  lines.push(`${sys.osName} (${sys.arch}) · ${sys.cpu} · ${sys.cores} cores · ${sys.mem}GB · ${sys.rustVer}\n`);

  return lines.join("\n");
};

const genMdZh = (data, sys) => {
  const { results, data_count } = data;
  const lines = [];

  lines.push("## VByte 编码性能评测\n");
  lines.push(`对比 varint 编码库，测试数据：${data_count.toLocaleString()} 个整数（混合分布：60% 小值，30% 中值，10% 大值）。\n`);

  lines.push("### 结果\n");
  lines.push("| 库 | 编码 (百万/秒) | 解码 (百万/秒) |");
  lines.push("|----|----------------|----------------|");

  for (const r of results) {
    const encThroughput = ((data_count / r.encode_ns) * 1e9 / 1e6).toFixed(1);
    const decThroughput = ((data_count / r.decode_ns) * 1e9 / 1e6).toFixed(1);
    lines.push(`| ${r.lib} | ${encThroughput} | ${decThroughput} |`);
  }
  lines.push("");

  lines.push("### 环境\n");
  lines.push(`${sys.osName} (${sys.arch}) · ${sys.cpu} · ${sys.cores} 核 · ${sys.mem}GB · ${sys.rustVer}\n`);

  return lines.join("\n");
};

const main = () => {
  const data = JSON.parse(readFileSync(JSON_PATH, "utf8"));
  const sys = getSystemInfo();

  printConsoleTable(data.results, data.data_count);

  const enMd = genMdEn(data, sys);
  writeFileSync(EN_MD, enMd);
  console.log(`\nWritten: ${EN_MD}`);

  const zhMd = genMdZh(data, sys);
  writeFileSync(ZH_MD, zhMd);
  console.log(`Written: ${ZH_MD}`);
};

main();