feat: initial commit

Author: funcpp

.envrc

@@ -0,0 +1 @@
+use flake

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy, rustfmt
+
+      - uses: Swatinem/rust-cache@v2
+
+      - run: cargo fmt --all -- --check
+      - run: cargo clippy --all-targets -- -D warnings
+      - run: cargo test --all

.gitignore

@@ -0,0 +1,5 @@
+/target
+.direnv/
+.DS_Store
+.idea/
+result

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "librdb-sys/librdb"]
+	path = librdb-sys/librdb
+	url = https://github.com/redis/librdb.git

.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - repo: local
+    hooks:
+      - id: cargo-fmt
+        name: cargo fmt
+        entry: cargo fmt --all --
+        language: system
+        pass_filenames: false
+
+      - id: cargo-clippy
+        name: cargo clippy
+        entry: cargo clippy --all-targets --all-features -- -D warnings
+        language: system
+        pass_filenames: false
+
+      - id: cargo-test
+        name: cargo test
+        entry: cargo test --all
+        language: system
+        pass_filenames: false

Cargo.lock

@@ -0,0 +1,11 @@
+[workspace]
+members = ["librdb-sys", "librdb"]
+resolver = "2"
+
+[workspace.lints.rust]
+unsafe_code = "deny"
+unused_results = "warn"
+
+[workspace.lints.clippy]
+pedantic = { level = "warn", priority = -1 }
+nursery = { level = "warn", priority = -1 }

Cargo.toml

@@ -0,0 +1,69 @@
+# rust-librdb
+
+Rust wrapper for [librdb](https://github.com/redis/librdb), the Redis RDB file parser.
+
+Parses RDB dump files and delivers Redis data types (strings, lists, hashes,
+sets, sorted sets, streams) through a callback trait, without loading the
+entire file into memory.
+
+| Crate | Description |
+|-------|-------------|
+| [`librdb`](librdb/) | Safe, high-level wrapper |
+| [`librdb-sys`](librdb-sys/) | Raw FFI bindings |
+
+## Installation
+
+```toml
+[dependencies]
+librdb = "0.1"
+```
+
+By default, librdb is compiled from the vendored source (git submodule).
+A C compiler is required.
+
+```sh
+git clone --recurse-submodules https://github.com/funcpp/rust-librdb
+cd rust-librdb
+cargo build
+```
+
+### Linking options
+
+| Method | How |
+|--------|-----|
+| Source build (default) | No extra steps |
+| System shared library | `--features librdb-sys/dynamic-linking` |
+| Pre-built static library | Set `DEP_LIBRDB_STATIC_ROOT`, use `--features librdb-sys/static-linking` |
+
+## Example
+
+```rust
+use librdb::{Parser, RdbHandlers, KeyInfo, Result};
+
+struct MyHandler {
+    keys: Vec<String>,
+}
+
+impl RdbHandlers for MyHandler {
+    fn handle_new_key(&mut self, key: &[u8], _info: &KeyInfo) -> Result<()> {
+        self.keys.push(String::from_utf8_lossy(key).into_owned());
+        Ok(())
+    }
+}
+
+fn main() -> librdb::Result<()> {
+    let mut parser = Parser::new(MyHandler { keys: vec![] })?;
+    parser.parse_file("dump.rdb")?;
+    let handler = parser.into_handler();
+    println!("{} keys parsed", handler.keys.len());
+    Ok(())
+}
+```
+
+`&[u8]` callback parameters borrow directly from librdb's internal buffer and
+are only valid for the duration of the callback. Clone if you need to retain
+the data.
+
+## License
+
+MIT

README.md

@@ -0,0 +1,35 @@
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+    rust-overlay.url = "github:oxalica/rust-overlay";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, rust-overlay, flake-utils }:
+    flake-utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = import nixpkgs {
+          inherit system;
+          overlays = [ rust-overlay.overlays.default ];
+        };
+        rust = pkgs.rust-bin.stable.latest.default.override {
+          extensions = [ "rust-src" "rust-analyzer" "clippy" "rustfmt" ];
+        };
+      in {
+        devShells.default = pkgs.mkShell {
+          buildInputs = with pkgs; [
+            rust
+            cargo-edit
+            cargo-watch
+            clang
+            libclang
+            pkg-config
+            pre-commit
+            cmake
+            gnumake
+          ];
+
+          LIBCLANG_PATH = "${pkgs.libclang.lib}/lib";
+        };
+      });
+}