FlatBuffers

Cargo.toml

@@ -8,6 +8,7 @@ members = [
     "vortex-alp",
     "vortex-dict",
     "vortex-fastlanes",
+    "vortex-flatbuffers",
     "vortex-ree",
     "vortex-roaring",
     "vortex-zigzag",

vortex-array/Cargo.toml

@@ -41,3 +41,4 @@ rayon = "1.8.1"
 roaring = "0.10.3"
 vortex-alloc = { path = "../vortex-alloc" }
 thiserror = "1.0.57"
+vortex-flatbuffers = { path = "../vortex-flatbuffers" }

vortex-flatbuffers/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+name = "vortex-flatbuffers"
+version = { workspace = true }
+description = "Flatbuffers for Vortex arrays"
+homepage = { workspace = true }
+repository = { workspace = true }
+authors = { workspace = true }
+license = { workspace = true }
+keywords = { workspace = true }
+include = { workspace = true }
+edition = { workspace = true }
+rust-version = { workspace = true }
+
+[lints]
+workspace = true
+
+[dependencies]
+flatbuffers = "23.5.26"
+
+[build-dependencies]
+walkdir = "2.4.0"

vortex-flatbuffers/build.rs

@@ -0,0 +1,55 @@
+use std::env;
+use std::ffi::OsStr;
+use std::path::{Path, PathBuf};
+use std::process::Command;
+use walkdir::WalkDir;
+
+fn main() {
+    let buildrs_dir = PathBuf::from(env::var("CARGO_MANIFEST_DIR").unwrap())
+        .canonicalize()
+        .expect("Failed to canonicalize CARGO_MANIFEST_DIR");
+    let out_dir = PathBuf::from(env::var("OUT_DIR").unwrap())
+        .canonicalize()
+        .expect("Failed to canonicalize OUT_DIR");
+    let _root_dir = buildrs_dir
+        .join("../")
+        .canonicalize()
+        .expect("Failed to canonicalize root dir");
+    let flatbuffers_dir = buildrs_dir.join("flatbuffers");
+
+    rerun_if_changed(&buildrs_dir.join("build.rs"));
+    WalkDir::new(&flatbuffers_dir)
+        .into_iter()
+        .filter_map(|e| e.ok())
+        .for_each(|e| rerun_if_changed(e.path()));
+
+    let exit = Command::new("flatc")
+        .arg("--rust")
+        .arg("-o")
+        .arg(out_dir.join("flatbuffers"))
+        .args(
+            WalkDir::new(&flatbuffers_dir)
+                .into_iter()
+                .filter_map(|e| e.ok())
+                .filter(|e| e.path().extension() == Some(OsStr::new("fbs")))
+                .map(|d| d.path().to_path_buf())
+                .map(|d| {
+                    rerun_if_changed(d.as_path());
+                    d
+                }),
+        )
+        .status()
+        .expect("Failed to execute flatc")
+        .success();
+    assert_eq!(exit, true, "flatc failed");
+}
+
+fn rerun_if_changed(path: &Path) {
+    println!(
+        "cargo:rerun-if-changed={}",
+        path.canonicalize()
+            .unwrap_or_else(|_| panic!("failed to canonicalize {}", path.to_str().unwrap()))
+            .to_str()
+            .unwrap()
+    );
+}

vortex-flatbuffers/flatbuffers/monsters.fbs

@@ -0,0 +1,34 @@
+// Example IDL file for our monster's schema.
+// https://google.github.io/flatbuffers/flatbuffers_guide_tutorial.html
+
+namespace MyGame.Sample;
+
+enum Color:byte { Red = 0, Green, Blue = 2 }
+
+union Equipment { Weapon } // Optionally add more tables.
+
+struct Vec3 {
+  x:float;
+  y:float;
+  z:float;
+}
+
+table Monster {
+  pos:Vec3; // Struct.
+  mana:short = 150;
+  hp:short = 100;
+  name:string;
+  friendly:bool = false (deprecated);
+  inventory:[ubyte];  // Vector of scalars.
+  color:Color = Blue; // Enum.
+  weapons:[Weapon];   // Vector of tables.
+  equipped:Equipment; // Union.
+  path:[Vec3];        // Vector of structs.
+}
+
+table Weapon {
+  name:string;
+  damage:short;
+}
+
+root_type Monster;

vortex-flatbuffers/src/lib.rs

@@ -0,0 +1,10 @@
+#![allow(unused_imports)]
+#![allow(dead_code)]
+mod flatbuffers {
+    include!(concat!(
+        env!("OUT_DIR"),
+        "/flatbuffers/monsters_generated.rs"
+    ));
+}
+
+pub use flatbuffers::*;