Deploy 6bb1fe7 to gh-pages

Author: Deploy from CI

.gitattributes

@@ -0,0 +1,63 @@
+###############################################################################
+# Set default behavior to automatically normalize line endings.
+###############################################################################
+* text=auto
+
+###############################################################################
+# Set default behavior for command prompt diff.
+#
+# This is need for earlier builds of msysgit that does not have it on by
+# default for csharp files.
+# Note: This is only used by command line
+###############################################################################
+#*.cs     diff=csharp
+
+###############################################################################
+# Set the merge driver for project and solution files
+#
+# Merging from the command prompt will add diff markers to the files if there
+# are conflicts (Merging from VS is not affected by the settings below, in VS
+# the diff markers are never inserted). Diff markers may cause the following 
+# file extensions to fail to load in VS. An alternative would be to treat
+# these files as binary and thus will always conflict and require user
+# intervention with every merge. To do so, just uncomment the entries below
+###############################################################################
+#*.sln       merge=binary
+#*.csproj    merge=binary
+#*.vbproj    merge=binary
+#*.vcxproj   merge=binary
+#*.vcproj    merge=binary
+#*.dbproj    merge=binary
+#*.fsproj    merge=binary
+#*.lsproj    merge=binary
+#*.wixproj   merge=binary
+#*.modelproj merge=binary
+#*.sqlproj   merge=binary
+#*.wwaproj   merge=binary
+
+###############################################################################
+# behavior for image files
+#
+# image files are treated as binary by default.
+###############################################################################
+#*.jpg   binary
+#*.png   binary
+#*.gif   binary
+
+###############################################################################
+# diff behavior for common document formats
+# 
+# Convert binary document formats to text before diffing them. This feature
+# is only available from the command line. Turn it on by uncommenting the 
+# entries below.
+###############################################################################
+#*.doc   diff=astextplain
+#*.DOC   diff=astextplain
+#*.docx  diff=astextplain
+#*.DOCX  diff=astextplain
+#*.dot   diff=astextplain
+#*.DOT   diff=astextplain
+#*.pdf   diff=astextplain
+#*.PDF   diff=astextplain
+#*.rtf   diff=astextplain
+#*.RTF   diff=astextplain

.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+
+on:
+  push:
+    branches-ignore:
+      - 'dependabot/**'
+  pull_request:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 8 * * 1'
+
+jobs:
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    
+    permissions:
+      actions: read
+      contents: read
+      checks: write
+      pull-requests: write
+      security-events: write
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          clean: true
+
+      - name: Install Rust
+        run: |
+          curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain nightly
+          source "$HOME/.cargo/env"
+
+      # REF: https://crates.io/crates/cargo2junit
+
+      - name: Install Cargo-to-JUnit
+        run: cargo install cargo2junit
+
+      - name: Cargo Build
+        run: |
+          cargo build --features alias,fmt,lazy
+          cargo build --features async
+
+      - name: Cargo Test
+        run: |
+          cargo test --features alias,fmt,lazy -- -Z unstable-options --format json --report-time | cargo2junit > target/debug/results.xml
+          cargo test --features async -- -Z unstable-options --format json --report-time | cargo2junit > target/debug/results-async.xml
+
+      # REF: https://github.com/marketplace/actions/publish-test-results
+
+      - name: Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: (!cancelled())
+        with:
+          files: |
+            target/debug/*.xml

.github/workflows/deploy.yml

@@ -0,0 +1,44 @@
+name: Deploy
+
+# REF: https://github.com/rust-lang/mdBook/wiki/Automated-Deployment%3A-GitHub-Actions
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Install Latest mdBook
+      run: |
+        tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+        url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+        mkdir mdbook
+        curl -sSL $url | tar -xz --directory=./mdbook
+        echo `pwd`/mdbook >> $GITHUB_PATH
+
+    - name: Deploy GitHub Pages
+      run: |
+        cd guide
+        mdbook build
+        git worktree add gh-pages
+        git config user.name "Deploy from CI"
+        git config user.email ""
+        cd gh-pages
+        # Delete the ref to avoid keeping history.
+        git update-ref -d refs/heads/gh-pages
+        rm -rf *
+        mv ../book/* .
+        git add .
+        git commit -m "Deploy $GITHUB_SHA to gh-pages"
+        git push --force --set-upstream origin gh-pages

.gitignore

@@ -0,0 +1,16 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# These files are copied from the root with build scripts
+/src/**/README.md
+
+# Generated book output
+guide/book

.vscode/extensions.json

@@ -0,0 +1,16 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+	// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+	// List of extensions which should be recommended for users of this workspace.
+	"recommendations": [
+		"rust-lang.rust-analyzer",
+		"streetsidesoftware.code-spell-checker",
+		"vadimcn.vscode-lldb",
+		"tamasfe.even-better-toml"
+	],
+	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+	"unwantedRecommendations": [
+		
+	]
+}

.vscode/rust.code-snippets

@@ -0,0 +1,49 @@
+{
+	"Rust Test": {
+	  "prefix": "test",
+	  "scope": "rust",
+	  "body": [
+		"#[test]",
+		"fn ${1:name}() {",
+		"    // arrange",
+		"    $0\n",
+		"    // act",
+		"    \n",
+		"    // assert",
+		"    ",
+		"}"
+	  ],
+	  "description": "Code snippet for a test method"
+	},
+  
+	"Rust Test Case": {
+	  "prefix": "testcase",
+	  "scope": "rust",
+	  "body": [
+		"#[test_case(${1:data} ; \"${2:case}\")]",
+		"fn ${3:name}(${4:argName}: ${5:argType}) {",
+		"    // arrange",
+		"    $0\n",
+		"    // act",
+		"    \n",
+		"    // assert",
+		"    ",
+		"}"
+	  ],
+	  "description": "Code snippet for a parameterized test method"
+	},
+  
+	"Rust Test Module": {
+	  "prefix": "testmod",
+	  "scope": "rust",
+	  "body": [
+		"#[cfg(test)]",
+		"mod tests {\n",
+		"    use super::*;",
+		"    use test_case::test_case;\n",
+		"    $0",
+		"}"
+	  ],
+	  "description": "Code snippet for a nested unit test module"
+	}
+  }

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "rust-analyzer.cargo.features": ["inject"],
+    "debug.allowBreakpointsEverywhere": true
+}

.vscode/tasks.json

@@ -0,0 +1,26 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "cargo",
+			"subcommand": "build",
+			"problemMatcher": [
+				"$rustc"
+			],
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			},
+			"label": "Rust: cargo build"
+		},
+		{
+			"type": "cargo",
+			"subcommand": "test",
+			"problemMatcher": [
+				"$rustc"
+			],
+			"group": "test",
+			"label": "Rust: cargo test"
+		}
+	]
+}