🚀 bsdiff-rust

A high-performance binary differential patching library based on Rust and NAPI-RS, providing an optimized bsdiff/bspatch algorithm implementation for Node.js. Built on qbsdiff library with standard BSDIFF40 format support, featuring suffix array algorithms and parallel processing.


Chinese README

✨ Core Features

- Standard Compatible: Generates standard BSDIFF40 format, fully compatible with bsdiff-node
- Memory Safe: Rust guarantees memory safety and thread safety, high-performance Node.js bindings via napi-rs
- Optimized Compression: Uses bzip2 compression with memory pre-allocation optimizations
- Cross-platform: Supports Windows, macOS, Linux

🚀 Quick Start

$3

``bash
pnpm install @bsdiff-rust/node
`

$3

`javascript
const bsdiff = require('@bsdiff-rust/node')

// Synchronous API
bsdiff.diffSync('old-file.zip', 'new-file.zip', 'patch.bin')
bsdiff.patchSync('old-file.zip', 'generated-file.zip', 'patch.bin')

// Asynchronous API
await bsdiff.diff('old-file.zip', 'new-file.zip', 'patch.bin')
await bsdiff.patch('old-file.zip', 'generated-file.zip', 'patch.bin')
`

$3

`typescript
import { diff, diffSync, patch, patchSync } from '@bsdiff-rust/node'

// Generate and apply patches
await diff('old-file.zip', 'new-file.zip', 'patch.bin')
await patch('old-file.zip', 'generated-file.zip', 'patch.bin')
`

Need performance monitoring or custom configuration? See Complete API Documentation

📖 API Documentation

$3

`typescript
// Synchronous methods
diffSync(oldFile: string, newFile: string, patchFile: string): void
patchSync(oldFile: string, newFile: string, patchFile: string): void

// Asynchronous methods
diff(oldFile: string, newFile: string, patchFile: string): Promise
patch(oldFile: string, newFile: string, patchFile: string): Promise
`

Need advanced features? See the Complete Guide for performance stats, configuration options, testing, and benchmarks.

🧪 Testing

`bash


Run functional tests

pnpm test

Run performance benchmarks

pnpm run bench
`

🔧 Development Guide

$3

- Node.js: >= 16 (Latest LTS recommended)
- Rust: >= 1.70
- Package Manager: npm or pnpm

$3

`bash


Install dependencies

pnpm install

Build release version

pnpm build

Build debug version

pnpm build:debug

Build for specific platform

pnpm build:arm64
`

$3

`bash


Code formatting

pnpm format

Code linting

pnpm lint

Run tests

pnpm test

Performance testing

pnpm bench
`

$3

`
bsdiff-rust/
├── src/
│ ├── lib.rs # NAPI binding entry
│ ├── bsdiff_rust.rs # Core Rust implementation
├── benchmark/
│ └── benchmark.ts # TypeScript benchmarks
├── test/
│ ├── index.ts # Functional tests
│ └── resources/ # Test resource files
├── index.js # Node.js entry point
├── index.d.ts # TypeScript type definitions
├── Cargo.toml # Rust project configuration
└── package.json # Node.js project configuration
`

🌍 Cross-platform Support

$3

- macOS: ARM64 (Apple Silicon) and x64 (Intel)
- Linux: ARM64 and x64 (GNU and musl)
- Windows: ARM64 and x64 (MSVC)

$3

This project uses napi-rs's multi-package strategy, automatically downloading precompiled binaries for the corresponding platform during installation:

`
npm/
├── @bsdiff-rust/darwin-arm64/ # macOS ARM64
├── @bsdiff-rust/darwin-x64/ # macOS x64
├── @bsdiff-rust/linux-arm64-gnu/ # Linux ARM64 glibc
├── @bsdiff-rust/linux-x64-gnu/ # Linux x64 glibc
├── @bsdiff-rust/linux-arm64-musl/ # Linux ARM64 musl
├── @bsdiff-rust/linux-x64-musl/ # Linux x64 musl
└── ...
`

Advantages:

- 🚀 Fast Installation: No compilation needed, direct download of precompiled binaries
- 📦 On-demand Download: Only downloads files needed for the current platform
- 🛡️ Stable and Reliable: Avoids installation failures due to compilation environment issues

🤝 Contributing

$3

1. Fork the project
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Create a Pull Request

$3

- Rust Code: Use cargo fmt` for formatting
- JavaScript/TypeScript: Use Prettier for formatting
- Commit Messages: Use clear English descriptions

📚 References

- Complete Guide - API reference, testing, and performance benchmarks
- bsdiff Original Algorithm - Colin Percival's original implementation
- NAPI-RS Documentation - Node.js binding framework
- qbsdiff Library - Underlying Rust implementation

---

⭐ If this project helps you, please give it a star!

🐛 Found an issue? Feel free to submit an Issue

💡 Have suggestions for improvement? Welcome to submit a Pull Request