memmapix 0.9.0

A pure Rust library for cross-platform memory mapped IO, which replaces libc with rustix
Documentation
name: CI

on:
  push:
    branches:
      - main
      - dev
    paths-ignore:
      - 'COPYRIGHT'
      - 'LICENSE-*'
      - '**.md'
      - '**.txt'
  pull_request:
    paths-ignore:
      - 'COPYRIGHT'
      - 'LICENSE-*'
      - '**.md'
      - '**.txt'
  workflow_dispatch:
  schedule:
    - cron: "0 1 1 * *"

env:
  CARGO_TERM_COLOR: always
  RUSTFLAGS: -Dwarnings
  RUST_BACKTRACE: 1
  nightly: nightly

jobs:
  # This represents the minimum Rust version supported by memmapix.
  # Matches `rust-version` in Cargo.toml. Tests are not run because
  # dev-dependencies (tempfile, owning_ref) don't follow MSRV.
  minrust:
    name: minrust
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Install Rust
        run: rustup update 1.63.0 && rustup default 1.63.0
      - name: Check
        run: cargo check --all-features

  # Check formatting (platform-independent, one OS is enough)
  rustfmt:
    name: rustfmt
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v6
    - name: Install Rust
      run: rustup update stable && rustup default stable && rustup component add rustfmt
    - name: Check formatting
      run: cargo fmt --all -- --check

  # Apply clippy lints across every feature combination on each host OS
  clippy:
    name: clippy
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    runs-on: ${{ matrix.os }}
    steps:
    - uses: actions/checkout@v6
    - name: Install Rust
      # --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
      run: rustup update stable --no-self-update && rustup default stable && rustup component add clippy
    - name: Install cargo-hack
      uses: taiki-e/install-action@v2
      with:
        tool: cargo-hack
    - name: Apply clippy lints
      run: cargo hack clippy --each-feature --all-targets

  # Cross-compile to extra unix/windows targets.
  #
  # All targets here produce an rlib, so no linker is invoked and NDK/
  # MinGW toolchains are only needed when present.
  cross:
    name: cross (${{ matrix.target }})
    strategy:
      fail-fast: false
      matrix:
        target:
          - aarch64-unknown-linux-gnu
          - aarch64-unknown-linux-musl
          - aarch64-linux-android
          - i686-linux-android
          - x86_64-linux-android
          - i686-pc-windows-gnu
          - x86_64-pc-windows-gnu
          - i686-unknown-linux-gnu
          - powerpc64-unknown-linux-gnu
          - riscv64gc-unknown-linux-gnu
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Cache cargo build and registry
        uses: actions/cache@v5
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-cross-${{ matrix.target }}-${{ hashFiles('**/Cargo.toml') }}
          restore-keys: |
            ${{ runner.os }}-cross-${{ matrix.target }}-
            ${{ runner.os }}-cross-
      - name: Install Rust
        run: rustup update stable && rustup default stable
      - name: Install MinGW toolchain for Windows GNU cross targets
        # windows-sys >= 0.61 generates import libraries via `dlltool`
        # when building for *-pc-windows-gnu. ubuntu-latest ships the
        # x86_64 MinGW toolchain pre-installed, but not the i686 one.
        if: contains(matrix.target, 'pc-windows-gnu')
        run: |
          sudo apt-get update
          sudo apt-get install -y gcc-mingw-w64 binutils-mingw-w64
      - name: cargo build --target ${{ matrix.target }}
        run: |
          rustup target add ${{ matrix.target }}
          cargo build --all-features --target ${{ matrix.target }}

  # Confirm the `not(any(unix, windows))` stub path still compiles.
  check-stub:
    name: check-stub (wasm32)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Install Rust
        run: rustup update stable && rustup default stable && rustup target add wasm32-unknown-unknown
      - name: Run check
        run: cargo check --all-features --target wasm32-unknown-unknown

  build:
    name: build
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    runs-on: ${{ matrix.os }}
    steps:
    - uses: actions/checkout@v6
    - name: Cache cargo build and registry
      uses: actions/cache@v5
      with:
        path: |
          ~/.cargo/registry
          ~/.cargo/git
          target
        key: ${{ runner.os }}-build-${{ hashFiles('**/Cargo.toml') }}
        restore-keys: |
          ${{ runner.os }}-build-
    - name: Install Rust
      # --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
      run: rustup update stable --no-self-update && rustup default stable
    - name: Install cargo-hack
      uses: taiki-e/install-action@v2
      with:
        tool: cargo-hack
    - name: Run build
      run: cargo hack build --each-feature

  test:
    name: test
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    runs-on: ${{ matrix.os }}
    steps:
    - uses: actions/checkout@v6
    - name: Cache cargo build and registry
      uses: actions/cache@v5
      with:
        path: |
          ~/.cargo/registry
          ~/.cargo/git
          target
        key: ${{ runner.os }}-test-${{ hashFiles('**/Cargo.toml') }}
        restore-keys: |
          ${{ runner.os }}-test-
    - name: Install Rust
      # --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
      run: rustup update stable --no-self-update && rustup default stable
    - name: Install cargo-hack
      uses: taiki-e/install-action@v2
      with:
        tool: cargo-hack
    - name: Run test
      # Several tests touch shared tempfiles; keep them serial to avoid flakes.
      run: cargo hack test --each-feature -- --test-threads 1