Rust bindings

.devcontainer/Dockerfile

@@ -91,4 +91,5 @@ RUN git clone https://github.com/microsoft/vcpkg \
 
 ENV VCPKG_ROOT="/home/${USERNAME}/vcpkg"
 
-RUN rustup default 1.88.0
+COPY ./scripts/ /tmp/scripts/
+RUN /tmp/scripts/common/rust/install-rust.sh

.devcontainer/Dockerfile.almalinux

@@ -78,4 +78,5 @@ RUN git clone https://github.com/microsoft/vcpkg \
 
 ENV VCPKG_ROOT=/home/$USERNAME/vcpkg
 
-RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain=1.88.0
+COPY ./scripts/ /tmp/scripts/
+RUN /tmp/scripts/common/rust/install-rust.sh

.devcontainer/Dockerfile.amazonlinux

@@ -77,4 +77,5 @@ RUN git clone https://github.com/microsoft/vcpkg \
 
 ENV VCPKG_ROOT=/home/$USERNAME/vcpkg
 
-RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain=1.88.0
+COPY ./scripts/ /tmp/scripts/
+RUN /tmp/scripts/common/rust/install-rust.sh

.devcontainer/Dockerfile.debiantrixie

@@ -86,4 +86,5 @@ RUN git clone https://github.com/microsoft/vcpkg \
 
 ENV VCPKG_ROOT="/home/${USERNAME}/vcpkg"
 
-RUN rustup default 1.88.0
+COPY ./scripts/ /tmp/scripts/
+RUN /tmp/scripts/common/rust/install-rust.sh

.devcontainer/Dockerfile.ubuntu-legacy

@@ -104,4 +104,5 @@ ENV VCPKG_ROOT=/home/$USERNAME/vcpkg
 # Make the selected clang version the default alternative
 RUN sudo /tmp/scripts/debian/register-clang-version.sh ${CLANG_VERSION} 100 
 
-RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain=1.88.0
+COPY ./scripts/ /tmp/scripts/
+RUN /tmp/scripts/common/rust/install-rust.sh

.devcontainer/almalinux/devcontainer.json

@@ -28,7 +28,8 @@
                 "matepek.vscode-catch2-test-adapter",
                 "llvm-vs-code-extensions.vscode-clangd",
                 "xaver.clang-format",
-                "bierner.markdown-mermaid"
+                "bierner.markdown-mermaid",
+                "rust-lang.rust-analyzer"
             ],
             "settings": {
                 "C_Cpp.intelliSenseEngine": "disabled",
@@ -37,7 +38,10 @@
                 "editor.formatOnSave": true,
                 "[cpp]": {
                     "editor.defaultFormatter": "xaver.clang-format"
-                }
+                },
+                "rust-analyzer.linkedProjects": [
+                    "${workspaceFolder}/rust/Cargo.toml"
+                ]
             }
         }
     },
@@ -50,4 +54,4 @@
         "gpu": "optional"
     },
     "remoteUser": "devcontainer"
-}
+}

.devcontainer/amazonlinux/devcontainer.json

@@ -32,7 +32,8 @@
                 "matepek.vscode-catch2-test-adapter",
                 "llvm-vs-code-extensions.vscode-clangd",
                 "xaver.clang-format",
-                "bierner.markdown-mermaid"
+                "bierner.markdown-mermaid",
+                "rust-lang.rust-analyzer"
             ],
             "settings": {
                 "C_Cpp.intelliSenseEngine": "disabled",
@@ -41,7 +42,10 @@
                 "editor.formatOnSave": true,
                 "[cpp]": {
                     "editor.defaultFormatter": "xaver.clang-format"
-                }
+                },
+                "rust-analyzer.linkedProjects": [
+                    "${workspaceFolder}/rust/Cargo.toml"
+                ]
             }
         }
     },
@@ -51,4 +55,4 @@
         "DISPLAY": "${localEnv:DISPLAY}"
     },
     "remoteUser": "devcontainer"
-}
+}

.devcontainer/debiantrixie/devcontainer.json

@@ -28,7 +28,8 @@
                 "matepek.vscode-catch2-test-adapter",
                 "llvm-vs-code-extensions.vscode-clangd",
                 "xaver.clang-format",
-                "bierner.markdown-mermaid"
+                "bierner.markdown-mermaid",
+                "rust-lang.rust-analyzer"
             ],
             "settings": {
                 "C_Cpp.intelliSenseEngine": "disabled",
@@ -37,7 +38,10 @@
                 "editor.formatOnSave": true,
                 "[cpp]": {
                     "editor.defaultFormatter": "xaver.clang-format"
-                }
+                },
+                "rust-analyzer.linkedProjects": [
+                    "${workspaceFolder}/rust/Cargo.toml"
+                ]
             }
         }
     },
@@ -50,4 +54,4 @@
         "gpu": "optional"
     },
     "remoteUser": "devcontainer"
-}
+}

.devcontainer/scripts/common/rust/install-rust.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: 2025 Contributors to the Media eXchange Layer project.
+# SPDX-License-Identifier: Apache-2.0
+
+set -eu
+
+RUST_VERSION=1.90.0
+
+if command -v rustup > /dev/null 2>&1; then
+    rustup default $RUST_VERSION
+else
+    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain=$RUST_VERSION
+    . "$HOME/.cargo/env"
+fi
+
+# Install cargo binstall
+curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
+
+cargo binstall cargo-audit --locked
+cargo binstall cargo-outdated --locked
+
+# udeps requires the nightly compiler, so using machete (at least for now)
+# cargo binstall cargo-udeps --locked
+cargo binstall cargo-machete --locked
+
+cargo binstall cargo-deny --locked
+cargo binstall cargo-nextest --locked

.devcontainer/ubuntu20/devcontainer.json

@@ -30,7 +30,8 @@
                 "matepek.vscode-catch2-test-adapter",
                 "llvm-vs-code-extensions.vscode-clangd",
                 "xaver.clang-format",
-                "bierner.markdown-mermaid"
+                "bierner.markdown-mermaid",
+                "rust-lang.rust-analyzer"
             ],
             "settings": {
                 "C_Cpp.intelliSenseEngine": "disabled",
@@ -39,7 +40,10 @@
                 "editor.formatOnSave": true,
                 "[cpp]": {
                     "editor.defaultFormatter": "xaver.clang-format"
-                }
+                },
+                "rust-analyzer.linkedProjects": [
+                    "${workspaceFolder}/rust/Cargo.toml"
+                ]
             }
         }
     },
@@ -52,4 +56,4 @@
         "gpu": "optional"
     },
     "remoteUser": "devcontainer"
-}
+}

.devcontainer/ubuntu22/devcontainer.json

@@ -30,7 +30,8 @@
                 "matepek.vscode-catch2-test-adapter",
                 "llvm-vs-code-extensions.vscode-clangd",
                 "xaver.clang-format",
-                "bierner.markdown-mermaid"
+                "bierner.markdown-mermaid",
+                "rust-lang.rust-analyzer"
             ],
             "settings": {
                 "C_Cpp.intelliSenseEngine": "disabled",
@@ -39,7 +40,10 @@
                 "editor.formatOnSave": true,
                 "[cpp]": {
                     "editor.defaultFormatter": "xaver.clang-format"
-                }
+                },
+                "rust-analyzer.linkedProjects": [
+                    "${workspaceFolder}/rust/Cargo.toml"
+                ]
             }
         }
     },
@@ -52,4 +56,4 @@
         "gpu": "optional"
     },
     "remoteUser": "devcontainer"
-}
+}

.devcontainer/ubuntu24/devcontainer.json

@@ -30,7 +30,8 @@
                 "matepek.vscode-catch2-test-adapter",
                 "llvm-vs-code-extensions.vscode-clangd",
                 "xaver.clang-format",
-                "bierner.markdown-mermaid"
+                "bierner.markdown-mermaid",
+                "rust-lang.rust-analyzer"
             ],
             "settings": {
                 "C_Cpp.intelliSenseEngine": "disabled",
@@ -39,7 +40,10 @@
                 "editor.formatOnSave": true,
                 "[cpp]": {
                     "editor.defaultFormatter": "xaver.clang-format"
-                }
+                },
+                "rust-analyzer.linkedProjects": [
+                    "${workspaceFolder}/rust/Cargo.toml"
+                ]
             }
         }
     },
@@ -52,4 +56,4 @@
         "gpu": "optional"
     },
     "remoteUser": "devcontainer"
-}
+}

.devcontainer/ubuntu25/devcontainer.json

@@ -30,7 +30,8 @@
                 "matepek.vscode-catch2-test-adapter",
                 "llvm-vs-code-extensions.vscode-clangd",
                 "xaver.clang-format",
-                "bierner.markdown-mermaid"
+                "bierner.markdown-mermaid",
+                "rust-lang.rust-analyzer"
             ],
             "settings": {
                 "C_Cpp.intelliSenseEngine": "disabled",
@@ -39,7 +40,10 @@
                 "editor.formatOnSave": true,
                 "[cpp]": {
                     "editor.defaultFormatter": "xaver.clang-format"
-                }
+                },
+                "rust-analyzer.linkedProjects": [
+                    "${workspaceFolder}/rust/Cargo.toml"
+                ]
             }
         }
     },
@@ -52,4 +56,4 @@
         "gpu": "optional"
     },
     "remoteUser": "devcontainer"
-}
+}

.github/workflows/build.yml

@@ -87,6 +87,9 @@ jobs:
           mkdir -p ${{ github.workspace }}/install
           chmod 777 ${{ github.workspace }}/install
           chmod g+s ${{ github.workspace }}/install
+          mkdir -p ${{ github.workspace }}/rust/target
+          chmod 777 ${{ github.workspace }}/rust/target
+          chmod g+s ${{ github.workspace }}/rust/target
 
       - name: Build Docker image
         if: steps.check-image.outputs.exists == 'false'
@@ -173,6 +176,52 @@ jobs:
               ctest --output-junit test-results.xml
             "
 
+      - name: Cache Cargo registry
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-lint-${{ hashFiles('**/Cargo.toml') }}
+          restore-keys: ${{ runner.os }}-cargo-lint-
+
+      - name: Check the Rust bindings
+        env:
+          RUSTFLAGS: "-Dwarnings"
+        run: |
+          docker run --mount src=${{ github.workspace }},target=/workspace/mxl,type=bind \
+            -i mxl_build_container_with_source \
+            bash -c "
+              cd /workspace/mxl/rust && \
+              cargo fmt -- --check && \
+              cargo clippy --all-targets --all-features --locked -- -D warnings && \
+              cargo audit && \
+              cargo outdated && \
+              cargo machete && \
+              cargo deny check all
+            "
+
+      - name: Build Rust bindings
+        run: |
+          docker run --mount src=${{ github.workspace }},target=/workspace/mxl,type=bind \
+            -i mxl_build_container_with_source \
+            bash -c "
+              cd /workspace/mxl/rust && \
+              cargo build --release --all-targets --locked
+            "
+
+      - name: Test the Rust bindings
+        run: |
+          docker run --mount src=${{ github.workspace }},target=/workspace/mxl,type=bind \
+            -i mxl_build_container_with_source \
+            bash -c "
+              cd /workspace/mxl/rust && \
+              cargo nextest run --release --locked
+            "
+
       - name: Publish Test Results
         uses: EnricoMi/publish-unit-test-result-action@v2
         if: always()

.vscode/settings.json

@@ -1,6 +1,9 @@
 // SPDX-FileCopyrightText: 2025 Contributors to the Media eXchange Layer project https://github.com/dmf-mxl/mxl/contributors.md
 // SPDX-License-Identifier: Apache-2.0
 {
+  "rust-analyzer.linkedProjects": [
+    "rust/Cargo.toml"
+  ],
   "files.associations": {
     "array": "cpp",
     "atomic": "cpp",
@@ -71,4 +74,4 @@
     "typeinfo": "cpp",
     "variant": "cpp"
   }
-}
+}