Merge pull request #1135 from dotnet/mxstream-2

Add Rust MultiplexingStream crate

Author: AArnott

.github/workflows/build.yml

@@ -83,6 +83,27 @@ jobs:
       run: corepack pnpm lint
       working-directory: src/nerdbank-streams
 
+    - name: 🦀 Install Rust 1.85.0
+      uses: dtolnay/rust-toolchain@1.85.0
+      with:
+        components: rustfmt, clippy
+    - name: 🦀 cargo build
+      run: cargo build --locked
+      working-directory: src/nerdbank-streams-rs
+    - name: 🦀 cargo test
+      run: cargo test --locked
+      working-directory: src/nerdbank-streams-rs
+    - name: 🦀 Verify Rust formatting
+      run: cargo fmt --check
+      working-directory: src/nerdbank-streams-rs
+    - name: 🦀 cargo clippy
+      run: cargo clippy --locked --all-targets -- -D warnings
+      working-directory: src/nerdbank-streams-rs
+    - name: 🦀 Package crate
+      run: tools/Pack-Cargo.ps1
+      shell: pwsh
+      if: runner.os == 'Linux'
+
     - name: 💅🏻 Verify formatted code
       run: dotnet format --verify-no-changes --no-restore
       shell: pwsh

.github/workflows/release.yml

@@ -16,6 +16,10 @@ on:
         description: Skip publishing NuGet packages
         type: boolean
         default: false
+      skip_cargo:
+        description: Skip publishing Cargo packages
+        type: boolean
+        default: false
 
 run-name: ${{ github.ref_name }}
 
@@ -127,6 +131,29 @@ jobs:
         registry-url: https://registry.npmjs.org
         package-manager-cache: false  # never use caching in release builds
 
+    - name: 🦀 Install Rust 1.85.0
+      uses: dtolnay/rust-toolchain@1.85.0
+
+    # The crate must first be manually published and configured for Trusted
+    # Publishing at crates.io before this OIDC exchange can succeed.
+    - name: 🪪 Authorize crates.io publishing
+      if: ${{ !inputs.skip_cargo }}
+      id: crates-io-auth
+      uses: rust-lang/crates-io-auth-action@c6f97d42243bad5fab37ca0427f495c86d5b1a18 # v1.0.5
+
+    - name: 🚀 Push Cargo package
+      if: ${{ !inputs.skip_cargo }}
+      shell: pwsh
+      env:
+        CARGO_REGISTRY_TOKEN: ${{ steps.crates-io-auth.outputs.token }}
+      run: |
+        $crate = (Get-ChildItem ./deployables -Filter 'nerdbank-streams-*.crate' -Recurse)[0].FullName
+        $packageDirectory = Join-Path $PWD 'cargo-package'
+        tar -xzf $crate -C $packageDirectory
+        $manifest = (Get-ChildItem $packageDirectory -Filter Cargo.toml -Recurse)[0].FullName
+        cargo publish --manifest-path $manifest --no-verify --token $env:CARGO_REGISTRY_TOKEN
+      working-directory: ${{ runner.temp }}
+
     - name: 🚀 Push NPM packages
       if: ${{ !inputs.skip_npm }}
       shell: pwsh

.gitignore

@@ -356,6 +356,11 @@ MigrationBackup/
 # mac-created file to track user view preferences for a directory
 .DS_Store
 
+# Rust build and editor artifacts
+**/target/
+*.rs.bk
+.rust-analyzer/
+
 # Analysis results
 *.sarif
 

src/nerdbank-streams-rs/Cargo.lock

@@ -0,0 +1,32 @@
+[package]
+name = "nerdbank-streams"
+# This placeholder is replaced in the staging copy by tools/Pack-Cargo.ps1
+# using Nerdbank.GitVersioning, before invoking `cargo package`.
+version = "0.0.0-placeholder"
+edition = "2021"
+rust-version = "1.85"
+description = "Tokio implementation of the Nerdbank.Streams multiplexing protocol"
+license = "MIT"
+repository = "https://github.com/AArnott/Nerdbank.Streams"
+homepage = "https://github.com/AArnott/Nerdbank.Streams"
+documentation = "https://docs.rs/nerdbank-streams"
+readme = "README.md"
+keywords = ["tokio", "multiplexing", "streams", "async"]
+categories = ["asynchronous", "network-programming"]
+authors = ["Andrew Arnott"]
+include = ["Cargo.toml", "Cargo.lock", "README.md", "LICENSE", "src/**"]
+
+[dependencies]
+rand = "0.9"
+rmp = "0.8"
+tokio = { version = "1.48", features = ["io-util", "macros", "rt", "sync"] }
+
+[dev-dependencies]
+tokio = { version = "1.48", features = ["io-util", "macros", "rt-multi-thread", "process", "time"] }
+
+[lints.rust]
+unsafe_code = "forbid"
+missing_docs = "warn"
+
+[lints.clippy]
+all = "warn"