Add: Rust bindings generate using bindgen

.gitignore

@@ -41,6 +41,7 @@ CMakeCache.txt
 cmake_install.cmake
 CMakeFiles
 build/
+target/
 build_debug/
 build_release/
 tmp/

.vscode/c_cpp_properties.json

@@ -2,7 +2,11 @@
     "configurations": [
         {
             "name": "Linux",
-            "configurationProvider": "ms-vscode.cmake-tools"
+            "configurationProvider": "ms-vscode.cmake-tools",
+            "includePath": [
+                "${default}",
+                "${workspaceFolder}/include"
+            ]
         }
     ],
     "version": 4

rust/.clippy.toml

@@ -0,0 +1,6 @@
+# Right now we just use the defaults. This file exists should we
+# want to change that, and to indicate to contributors that they
+# might want to run clippy.
+#
+# See https://rust-lang.github.io/rust-clippy/master/index.html for
+# the complete list of lints.

rust/.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig coding styles definitions. For more information about the
+# properties used in this file, please see the EditorConfig documentation:
+# http://editorconfig.org/
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = LF
+indent_size = 4
+indent_style = tab
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{yml,json}]
+indent_size = 2
+indent_style = space
+
+[*.{md,diff}]
+trim_trailing_whitespace = false

rust/CHANGELOG.md

@@ -0,0 +1,25 @@
+# CHANGELOG
+
+## 26-01-2023
+
+### Contributors
+
+-   chungquantin
+
+### Added
+
+-   Database structure
+
+```rs
+struct Database {
+ db: UkvDatabaseInitType
+}
+```
+
+-   Build bindings to `cpp` header file in `include/ukv`. To generate bindings code stored, use `cargo build`. `build.rs` includes code to build bindings using `bindgen`
+-   Support two APIs: `ukv_database_init` and `ukv_database_free`
+-   Add clippy, rust-fmt and editor config file for formatting and linting
+
+### Issues
+
+-   Can't generate bindings on file with linked source header. For example, generate on file `blobs.h` which includes `ukv/db.h` would throw error `No header file found`.

rust/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "ukv"
+version = "0.0.1"
+publish = true
+edition = "2021"
+readme = "CARGO.md"
+homepage = "https://github.com/unum-cloud/ukv"
+repository = "https://github.com/unum-cloud/ukv"
+documentation = "https://unum.cloud/ukv/rust/index.html"
+
+[build-dependencies]
+bindgen = "0.63.0"
+
+[lib]
+name = "ukv"
+
+[dependencies]
+thiserror = "1.0.38"

rust/README.md

@@ -2,10 +2,12 @@
 
 Rust implementation is designed to support:
 
-* Named Collections
-* ACID Transactions
-* Single & Batch Operations
-* [Apache DataFusion](https://arrow.apache.org/datafusion/) `TableProvider` for SQL
+-   Named Collections
+-   ACID Transactions
+-   Single & Batch Operations
+-   [Apache DataFusion](https://arrow.apache.org/datafusion/) `TableProvider` for SQL
+-   Tabular operation with [Polars](https://www.pola.rs/) and integration with [`Apache Arrow`](https://pola-rs.github.io/polars-book/user-guide/howcani/interop/arrow.html)
+-   NetworkX compatibility using [RustworkX](https://github.com/Qiskit/rustworkx)
 
 Using it should be, again, familiar, as it mimics [`std::collections`](https://doc.rust-lang.org/std/collections/hash_map/struct.HashMap.html):
 

rust/build.rs

@@ -0,0 +1,20 @@
+extern crate bindgen;
+
+use std::env::var;
+use std::path::PathBuf;
+
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+	println!("cargo:rerun-if-changed=wrapper.h");
+	// println!("cargo:rustc-link-search=../include");
+
+	let bindings = bindgen::Builder::default()
+		.header("./wrapper.h")
+		.clang_args(&["-I../include", "-I../include/ukv"])
+		.detect_include_paths(true)
+		.parse_callbacks(Box::new(bindgen::CargoCallbacks))
+		.generate()?;
+
+	let out_path = PathBuf::from(var("OUT_DIR")?);
+	bindings.write_to_file(out_path.join("bindings.rs"))?;
+	Ok(())
+}