Update CI, FUNDING, gitignore, and editor settings

.cargo/config.toml

@@ -0,0 +1,4 @@
+[build]
+rustdocflags = ["--cfg", "docsrs"]
+
+[env]

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: rkyv

.github/workflows/ci.yml

@@ -0,0 +1,149 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 10 * * *"
+
+permissions:
+  contents: read
+
+env:
+  RUSTFLAGS: -Dwarnings
+
+jobs:
+  features:
+    name: Features / ${{ matrix.std }} ${{ matrix.simdutf8 }} ${{ matrix.external }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        std:
+          - ''
+          - std
+        simdutf8:
+          - ''
+          - simdutf8
+        external:
+          - ''
+          - uuid
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo test --verbose --tests --no-default-features --features "${{ matrix.std }} ${{ matrix.simdutf8 }} ${{ matrix.external }}"
+
+  toolchain:
+    name: Toolchain / ${{ matrix.toolchain }} ${{ matrix.opt }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        toolchain:
+          - stable
+          - beta
+          - nightly
+        opt:
+          - ''
+          - --release
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.toolchain }}
+      - run: cargo test --verbose ${{ matrix.opt }}
+
+  miri:
+    name: Miri / ${{ matrix.opt }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        opt:
+          - ''
+          - --release
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@miri
+      - run: cargo miri setup
+      - run: cargo miri test ${{ matrix.opt }} --verbose
+        env:
+          MIRIFLAGS: -Zmiri-disable-stacked-borrows -Zmiri-tree-borrows
+
+  test:
+    name: Test / ${{ matrix.target }} ${{ matrix.opt }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        opt:
+          - ''
+          - --release
+        include:
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+          - os: macos-latest
+            target: aarch64-apple-darwin
+          - os: windows-latest
+            target: x86_64-pc-windows-msvc
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo test ${{ matrix.opt }}
+
+  cross:
+    name: Cross / ${{ matrix.target }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        target:
+          - i686-unknown-linux-gnu
+          - i586-unknown-linux-gnu
+          - armv7-unknown-linux-gnueabihf
+          - aarch64-unknown-linux-gnu
+          - thumbv6m-none-eabi
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo install cross
+      - run: cross build --no-default-features --features "simdutf8" --target ${{ matrix.target }} --verbose
+
+  format:
+    name: Format
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: rustfmt
+      - run: cargo fmt --check
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: clippy
+      - run: cargo clippy
+
+  doc:
+    name: Doc
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+      - run: cargo doc

.gitignore

@@ -1,3 +1,15 @@
+# Ignore build artifacts, backup files, and lockfiles
+
+target/
+**.*.rs.bk
 Cargo.lock
-/target
-/.vscode
+
+# Changes to VS Code configs are ignored by default. We intentionally check in
+# some settings when they're useful defaults.
+
+.vscode
+
+# Files ending in tildes are almost always temporary and not intended for
+# checkin.
+
+*~

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "rust-analyzer.cargo.features": [
+    "uuid",
+  ]
+}

Cargo.toml

@@ -15,7 +15,7 @@ documentation = "https://docs.rs/bytecheck"
 repository = "https://github.com/rkyv/bytecheck"
 
 [workspace.dependencies]
-bytecheck = { version = "0.8.0-alpha.9", path = "bytecheck", default-feature = false }
+bytecheck = { version = "0.8.0-alpha.9", path = "bytecheck", default-features = false }
 bytecheck_derive = { version = "0.8.0-alpha.9", path = "bytecheck_derive", default-features = false }
 proc-macro2 = { version = "1.0", default-features = false }
 ptr_meta = { version = "0.3.0-alpha.2", default-features = false }

bytecheck/src/lib.rs

@@ -18,12 +18,16 @@
 //! verifying that some bytes represent a valid type. Implementing it can be
 //! done manually or automatically with the [derive macro](macro@CheckBytes).
 //!
-//! ## Note
+//! ## Layout stability
 //!
-//! By default in-memory layout of a type may change between compiler versions or
-//! different compilations (see <https://doc.rust-lang.org/reference/type-layout.html>).
-//! In order to guarantee stable type layout between compilations `#[repr(C)]` attribute
-//! can be used.
+//! The layouts of types may change between compiler versions, or even different
+//! compilations. To guarantee stable type layout between compilations, structs,
+//! enums, and unions can be annotated with `#[repr(C)]`, and enums specifically
+//! can be annotated with `#[repr(int)]` or `#[repr(C, int)]` as well.
+//!
+//! See [the reference's page on type layout][reference] for more details.
+//!
+//! [reference]: https://doc.rust-lang.org/reference/type-layout.html
 //!
 //! ## Examples
 //!