Merge branch 'main' into deferred-system-kind

Author: Georgiy-Tugai

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: CI
 
 env:
   # When changing this, also update the `rust-version` in the workspace `Cargo.toml`
-  RUST_MIN_VER: "1.82"
+  RUST_MIN_VER: "1.85"
 
 on:
   push:
@@ -59,6 +59,7 @@ jobs:
     name: cargo build + clippy (iOS)
     env:
         RUSTFLAGS: -Dwarnings
+        IPHONEOS_DEPLOYMENT_TARGET: "15.0"
     steps:
       - uses: actions/checkout@v4
       - name: install stable toolchain
@@ -72,6 +73,28 @@ jobs:
       - name: cargo clippy
         run: cargo clippy --target aarch64-apple-ios --all-targets --workspace
 
+  build-musl:
+    runs-on: ubuntu-latest
+    name: cargo build + test (musl)
+    env:
+        RUSTFLAGS: -Dwarnings
+    steps:
+      - uses: actions/checkout@v4
+      - name: install stable toolchain
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+          components: clippy
+          targets: x86_64-unknown-linux-musl
+      - name: Install musl tools
+        run: sudo apt-get install -y musl-tools
+      - name: cargo build
+        run: cargo build --target x86_64-unknown-linux-musl --all-targets --workspace
+      - name: cargo clippy
+        run: cargo clippy --target x86_64-unknown-linux-musl --all-targets --workspace
+      - name: cargo test
+        run: cargo test --target x86_64-unknown-linux-musl --workspace --features test-with-crash-handler
+
   build-msrv:
     runs-on: ubuntu-latest
     name: cargo build (MSRV)
@@ -96,6 +119,9 @@ jobs:
       - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: nightly
-      - uses: dtolnay/install@cargo-docs-rs
+        
+      # Compile cargo-docs-rs locally so it links against the runner's glibc.
+      - run: cargo install cargo-docs-rs --locked
+        
       - run: cargo docs-rs -p flecs_ecs
-      - run: cargo docs-rs -p flecs_ecs_derive
+      - run: cargo docs-rs -p flecs_ecs_derive

.github/workflows/deploy-book.yml

@@ -0,0 +1,39 @@
+name: Deploy mdBook
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: 'latest'
+
+      - name: Install mdbook-admonish
+        uses: taiki-e/install-action@v2
+        with:
+          tool: mdbook-admonish
+
+      - name: Build Book
+        run: |
+          cd flecs_ecs/doc/flecs
+          mdbook build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./flecs_ecs/doc/flecs/book

.gitignore

@@ -7,4 +7,8 @@ rustfmt.toml
 flecs_ecs/src/main.rs
 flecs_ecs_test/
 flecs_ecs/benches/fbench_log/
-flecs_ecs/src/old_cached_code/
+flecs_ecs/src/old_cached_code/
+flecs_ecs/doc/flecs/docreplace
+flecs_ecs/doc/flecs/book/
+flecs_ecs/doc/flecs/src/cheatsheet.md
+docreplace/

Cargo.toml

@@ -3,29 +3,41 @@ members = ["flecs_ecs", "flecs_ecs_derive", "flecs_ecs_sys", "test_crash_handler
 resolver = "2"
 
 exclude = [
-    "flecs_ecs_test"
+    "flecs_ecs_test",
+    "docreplace"
 ] 
 
 [workspace.package]
 edition = "2021"
 license = "MIT"
 repository = "https://github.com/Indra-db/Flecs-Rust"
 # When changing this, update the CI as well.
-rust-version = "1.82"
+rust-version = "1.85"
+
+[workspace.lints.clippy]
+doc_markdown = "warn"
+float_cmp = "warn"
+float_cmp_const = "warn"
+print_stderr = "warn"
+print_stdout = "warn"
+semicolon_if_nothing_returned = "warn"
+manual_let_else = "warn"
+redundant_closure_for_method_calls = "warn"
+redundant_else = "warn"
+unwrap_or_default = "warn"
+too_many_arguments = "allow"
+std_instead_of_core = "warn"
+std_instead_of_alloc = "warn"
+alloc_instead_of_core = "warn"
 
 [workspace.lints]
-clippy.doc_markdown = "warn"
-clippy.float_cmp = "warn"
-clippy.float_cmp_const = "warn"
-clippy.print_stderr = "warn"
-clippy.print_stdout = "warn"
-clippy.semicolon_if_nothing_returned = "warn"
 rust.unused_lifetimes = "warn"
 
 [workspace.dependencies]
 flecs_ecs = { version = "0.1.2", path = "flecs_ecs" }
 flecs_ecs_derive = { version = "0.1.0", path = "flecs_ecs_derive" }
 flecs_ecs_sys = { version = "0.1.2", path = "flecs_ecs_sys" }
+libc = "0.2.169"
 
 [profile.release]
 lto = true

Makefile.toml

@@ -78,4 +78,32 @@ command = "rustup"
 args = ["run", "nightly", "cargo", "fmt", "--", "--config", "format_code_in_doc_comments=true"]
 workspace = false
 
+[tasks.test-book]
+description = "Test the flecs rust book"
+command = "mdbook"
+args = ["test", "flecs_ecs/doc/flecs", "--library-path", "target/debug/deps"]
+workspace = false
+
+[tasks.install-mdbook]
+install_crate = { crate_name = "mdbook", binary = "mdbook", test_arg = "--version" }
+
+[tasks.install-mdbook-admonish]
+install_crate = { crate_name = "mdbook-admonish", binary = "mdbook-admonish", test_arg = "--version" }
+
+[tasks.install-book-deps]
+dependencies = [
+    "install-mdbook",
+    "install-mdbook-admonish"
+]
+
+[tasks.build-book]
+dependencies = ["install-book-deps"]
+cwd = "./flecs_ecs/doc/flecs"
+command = "mdbook"
+args = ["build"]
 
+[tasks.serve-book]
+dependencies = ["install-book-deps"]
+cwd = "./flecs_ecs/doc/flecs"
+command = "mdbook"
+args = ["serve", "--open"]

README.md

@@ -3,6 +3,8 @@ extend-exclude = [
   "flecs_ecs_sys/**/*",
   "target/**/*",
   "flecs_ecs/examples/flecs/z_ignore_test_snapshots/**/*",
+  "flecs_ecs/doc/flecs/theme/**/*",
+  "flecs_ecs/doc/flecs/book/**/*",
 ]
 
 [default.extend-words]

_typos.toml

@@ -23,9 +23,9 @@ cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
 [dependencies]
 flecs_ecs_derive = { workspace = true }
 flecs_ecs_sys = { workspace = true }
-bitflags = "2.6.0"
-compact_str = "0.8.0"
-hashbrown = "0.15.0"
+bitflags = "2.8.0"
+compact_str = { version = "0.9.0", default-features = false }
+hashbrown = "0.15.2"
 
 # used for backtraces upon hardware exceptions during test
 # only used when "test-with-crash-handler" feature enabled
@@ -34,18 +34,22 @@ test_crash_handler = { version = "0.1.0", path = "../test_crash_handler", option
 [dev-dependencies]
 criterion = "0.5.1"
 seq-macro = "0.3.5"
-rand = "0.8.5"
-ctor = "0.2.7"
-insta = { version = "1.38.0", features = ["yaml","filters"] }
+rand = "0.9.0"
+ctor = "0.4.0"
+insta = { version = "1.42.1", features = ["yaml","filters"] }
+libc.workspace = true
 # used for capturing stdout in the examples test cases. Works only on Nightly, meant
 # to be used with flecs_nightly_tests feature flag
 #capture-stdio = "0.1.1" 
 
-[features]
+[features] 
 ######################
 # sys feature flags
 ######################
 
+# use std
+std = ["flecs_ecs_derive/std", "compact_str/std"]
+
 # Regenerate the C binding for flecs C
 flecs_regenerate_binding_c = ["flecs_ecs_sys/regenerate_binding"]
 
@@ -72,6 +76,9 @@ flecs_disable_build_c = ["flecs_ecs_sys/disable_build_c"]
 # Flecs feature flags
 ######################
 
+# Enable query trait for Rust
+flecs_query_rust_traits = ["flecs_ecs_derive/flecs_query_rust_traits"]
+
 # Enable flecs performance tracing
 flecs_perf_trace = ["flecs_ecs_sys/flecs_perf_trace"]
 
@@ -149,27 +156,35 @@ flecs_nightly_tests = []
 # enable a backtrace on crashes during tests, used for e.g. debugging intermittent CI failures
 test-with-crash-handler = ["dep:test_crash_handler", "test_crash_handler/crash-handler"]
 
+# most common base features
+flecs_base = [
+   # this is commented since `no_std` is not ready yet
+    "std",
+    "flecs_module",
+    "flecs_system",
+    "flecs_pipeline",
+    "flecs_timer",
+    "flecs_os_api_impl",
+]
+
 default = [
     #"flecs_regenerate_binding_c",
     #"flecs_nightly_tests",
-    "flecs_module",
+    "flecs_base",
     "flecs_script",
     "flecs_snapshot",
     "flecs_stats",
     "flecs_metrics",
     "flecs_alerts",
-    "flecs_system",
-    "flecs_pipeline",
-    "flecs_timer",
     "flecs_meta",
     "flecs_units",
     "flecs_json",
     "flecs_doc",
     "flecs_log",
     "flecs_app",
-    "flecs_os_api_impl",
     "flecs_http",
     "flecs_rest",
+    "flecs_query_rust_traits"
 ]
 
 ######################

flecs_ecs/Cargo.toml

@@ -0,0 +1,24 @@
+[book]
+name = "Flecs Rust"
+authors = ["Indradb"]
+description = "Documentation for the Rust bindings of Flecs ECS"
+language = "en"
+multilingual = false
+src = "src"
+title = "Flecs Rust"
+
+[output.html]
+git-repository-url = "https://github.com/Indra-db/Flecs-Rust"
+edit-url-template = "https://github.com/Indra-db/Flecs-Rust/edit/main/flecs_ecs/doc/{path}"
+additional-css = ["theme/tabs.css", "theme/mdbook-admonish.css", "theme/mdbook-admonish.css"]
+additional-js = ["theme/tabs.js"]
+default-theme = "ayu"
+
+[output.html.playground]
+runnable = false
+
+[preprocessor.tabs]
+
+[preprocessor.admonish]
+command = "mdbook-admonish"
+assets_version = "3.0.3" # do not edit: managed by `mdbook-admonish install`