fsst - GitLite

KO | EN

gitlite — search

#python #typescript #llm #golang #android #machine-learning #rust #linux #windows #kubernetes #vue #ios #openai #open-source

fsst

(★ 226)

Pure-Rust implementation of Fast Static Symbol Tables string compression

File Explorer

Download Latest Version (.zip)

- - ci.yml
  - fuzz.yml
  - miri.yml
  - publish.yml
  - release-drafter.yml
- release-drafter.yml
- .gitignore
- compress.rs
- micro.rs
- file_compressor.rs
- round_trip.rs
- - fuzz_compress.rs
  - fuzz_train.rs
- .gitignore
- Cargo.lock
- Cargo.toml
- builder.rs
- lib.rs
- lossy_pht.rs
- - art_of_war.txt
  - declaration.txt
- correctness.rs
- exact_capacity.rs
.gitignore
Cargo.lock
Cargo.toml
CHANGELOG.md
LICENSE
logo.webp
README.md
renovate.json
rust-toolchain.toml

# Installation Guide

1. Get the code

git clone https://github.com/spiraldb/fsst

Downloads the entire project code from GitHub to your computer.

cd fsst

Moves into the project folder you just downloaded.

2. Rust

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <img src="https://raw.githubusercontent.com/spiraldb/fsst/develop/logo.webp" height="300">
</p>

![Crates.io Version](https://img.shields.io/crates/v/fsst_rs)
![docs.rs](https://img.shields.io/docsrs/fsst-rs)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/spiraldb/fsst/ci.yml?branch=develop)

# fsst-rs

A pure-Rust, zero-dependency implementation of the [FSST string compression algorithm][whitepaper].

FSST is a string compression algorithm meant for use in database systems. It was designed by
[Peter Boncz, Thomas Neumann, and Viktor Leis][whitepaper]. It provides 1-3GB/sec compression
and decompression of strings at compression rates competitive with or better than LZ4.

This implementation is somewhat inspired by the [MIT-licensed implementation] from the paper authors, written in C++,
but it is mostly written from a careful reading of the paper.

**NOTE: This current implementation is still in-progress and is not production ready, please use at your own risk.**

**NOTE: This crate only works on little-endian architectures currently. There are no current plans to support big-endian targets.**

[whitepaper]: https://www.vldb.org/pvldb/vol13/p2649-boncz.pdf
[MIT-licensed implementation]: https://github.com/cwida/fsst