├── .cargo └── config.toml ├── .clippy.toml ├── .github ├── renovate.json5 ├── settings.yml └── workflows │ ├── audit.yml │ ├── ci.yml │ ├── committed.yml │ ├── pre-commit.yml │ ├── rust-next.yml │ └── spelling.yml ├── .gitignore ├── .pre-commit-config.yaml ├── CHANGELOG.md ├── CONTRIBUTING.md ├── Cargo.lock ├── Cargo.toml ├── LICENSE-APACHE ├── LICENSE-MIT ├── README.md ├── committed.toml ├── deny.toml ├── release.toml └── src ├── bash.rs ├── code.rs ├── exit.rs ├── lib.rs └── sysexits.rs /.cargo/config.toml: -------------------------------------------------------------------------------- 1 | [resolver] 2 | incompatible-rust-versions = "fallback" 3 | -------------------------------------------------------------------------------- /.clippy.toml: -------------------------------------------------------------------------------- 1 | allow-print-in-tests = true 2 | allow-expect-in-tests = true 3 | allow-unwrap-in-tests = true 4 | allow-dbg-in-tests = true 5 | disallowed-methods = [ 6 | { path = "std::option::Option::map_or", reason = "prefer `map(..).unwrap_or(..)` for legibility" }, 7 | { path = "std::option::Option::map_or_else", reason = "prefer `map(..).unwrap_or_else(..)` for legibility" }, 8 | { path = "std::result::Result::map_or", reason = "prefer `map(..).unwrap_or(..)` for legibility" }, 9 | { path = "std::result::Result::map_or_else", reason = "prefer `map(..).unwrap_or_else(..)` for legibility" }, 10 | { path = "std::iter::Iterator::for_each", reason = "prefer `for` for side-effects" }, 11 | { path = "std::iter::Iterator::try_for_each", reason = "prefer `for` for side-effects" }, 12 | ] 13 | -------------------------------------------------------------------------------- /.github/renovate.json5: -------------------------------------------------------------------------------- 1 | { 2 | schedule: [ 3 | 'before 5am on the first day of the month', 4 | ], 5 | semanticCommits: 'enabled', 6 | commitMessageLowerCase: 'never', 7 | configMigration: true, 8 | dependencyDashboard: true, 9 | customManagers: [ 10 | { 11 | customType: 'regex', 12 | managerFilePatterns: [ 13 | '/^rust-toolchain\\.toml$/', 14 | '/Cargo.toml$/', 15 | '/clippy.toml$/', 16 | '/\\.clippy.toml$/', 17 | '/^\\.github/workflows/ci.yml$/', 18 | '/^\\.github/workflows/rust-next.yml$/', 19 | ], 20 | matchStrings: [ 21 | 'STABLE.*?(?\\d+\\.\\d+(\\.\\d+)?)', 22 | '(?\\d+\\.\\d+(\\.\\d+)?).*?STABLE', 23 | ], 24 | depNameTemplate: 'STABLE', 25 | packageNameTemplate: 'rust-lang/rust', 26 | datasourceTemplate: 'github-releases', 27 | }, 28 | ], 29 | packageRules: [ 30 | { 31 | commitMessageTopic: 'Rust Stable', 32 | matchManagers: [ 33 | 'custom.regex', 34 | ], 35 | matchDepNames: [ 36 | 'STABLE', 37 | ], 38 | extractVersion: '^(?\\d+\\.\\d+)', // Drop the patch version 39 | schedule: [ 40 | '* * * * *', 41 | ], 42 | automerge: true, 43 | }, 44 | // Goals: 45 | // - Keep version reqs low, ignoring compatible normal/build dependencies 46 | // - Take advantage of latest dev-dependencies 47 | // - Rollup safe upgrades to reduce CI runner load 48 | // - Help keep number of versions down by always using latest breaking change 49 | // - Have lockfile and manifest in-sync 50 | { 51 | matchManagers: [ 52 | 'cargo', 53 | ], 54 | matchDepTypes: [ 55 | 'build-dependencies', 56 | 'dependencies', 57 | ], 58 | matchCurrentVersion: '>=0.1.0', 59 | matchUpdateTypes: [ 60 | 'patch', 61 | ], 62 | enabled: false, 63 | }, 64 | { 65 | matchManagers: [ 66 | 'cargo', 67 | ], 68 | matchDepTypes: [ 69 | 'build-dependencies', 70 | 'dependencies', 71 | ], 72 | matchCurrentVersion: '>=1.0.0', 73 | matchUpdateTypes: [ 74 | 'minor', 75 | 'patch', 76 | ], 77 | enabled: false, 78 | }, 79 | { 80 | matchManagers: [ 81 | 'cargo', 82 | ], 83 | matchDepTypes: [ 84 | 'dev-dependencies', 85 | ], 86 | matchCurrentVersion: '>=0.1.0', 87 | matchUpdateTypes: [ 88 | 'patch', 89 | ], 90 | automerge: true, 91 | groupName: 'compatible (dev)', 92 | }, 93 | { 94 | matchManagers: [ 95 | 'cargo', 96 | ], 97 | matchDepTypes: [ 98 | 'dev-dependencies', 99 | ], 100 | matchCurrentVersion: '>=1.0.0', 101 | matchUpdateTypes: [ 102 | 'minor', 103 | 'patch', 104 | ], 105 | automerge: true, 106 | groupName: 'compatible (dev)', 107 | }, 108 | ], 109 | } 110 | -------------------------------------------------------------------------------- /.github/settings.yml: -------------------------------------------------------------------------------- 1 | # These settings are synced to GitHub by https://probot.github.io/apps/settings/ 2 | 3 | repository: 4 | description: "Exit codes for process termination" 5 | homepage: "docs.rs/proc-exit" 6 | topics: "rust cli exit-codes" 7 | has_issues: true 8 | has_projects: false 9 | has_wiki: false 10 | has_downloads: true 11 | default_branch: master 12 | 13 | # Preference: people do clean commits 14 | allow_merge_commit: true 15 | # Backup in case we need to clean up commits 16 | allow_squash_merge: true 17 | # Not really needed 18 | allow_rebase_merge: false 19 | 20 | allow_auto_merge: true 21 | delete_branch_on_merge: true 22 | 23 | squash_merge_commit_title: "PR_TITLE" 24 | squash_merge_commit_message: "PR_BODY" 25 | merge_commit_message: "PR_BODY" 26 | 27 | labels: 28 | # Type 29 | - name: bug 30 | color: '#b60205' 31 | description: "Not as expected" 32 | - name: enhancement 33 | color: '#1d76db' 34 | description: "Improve the expected" 35 | # Flavor 36 | - name: question 37 | color: "#cc317c" 38 | description: "Uncertainty is involved" 39 | - name: breaking-change 40 | color: "#e99695" 41 | - name: good first issue 42 | color: '#c2e0c6' 43 | description: "Help wanted!" 44 | 45 | # This serves more as documentation. 46 | # Branch protection API was replaced by rulesets but settings isn't updated. 47 | # See https://github.com/repository-settings/app/issues/825 48 | # 49 | # branches: 50 | # - name: master 51 | # protection: 52 | # required_pull_request_reviews: null 53 | # required_conversation_resolution: true 54 | # required_status_checks: 55 | # # Required. Require branches to be up to date before merging. 56 | # strict: false 57 | # contexts: ["CI", "Spell Check with Typos"] 58 | # enforce_admins: false 59 | # restrictions: null 60 | -------------------------------------------------------------------------------- /.github/workflows/audit.yml: -------------------------------------------------------------------------------- 1 | name: Security audit 2 | 3 | permissions: 4 | contents: read 5 | 6 | on: 7 | pull_request: 8 | paths: 9 | - '**/Cargo.toml' 10 | - '**/Cargo.lock' 11 | push: 12 | branches: 13 | - master 14 | 15 | env: 16 | RUST_BACKTRACE: 1 17 | CARGO_TERM_COLOR: always 18 | CLICOLOR: 1 19 | 20 | concurrency: 21 | group: "${{ github.workflow }}-${{ github.ref }}" 22 | cancel-in-progress: true 23 | 24 | jobs: 25 | security_audit: 26 | permissions: 27 | issues: write # to create issues (actions-rs/audit-check) 28 | checks: write # to create check (actions-rs/audit-check) 29 | runs-on: ubuntu-latest 30 | # Prevent sudden announcement of a new advisory from failing ci: 31 | continue-on-error: true 32 | steps: 33 | - name: Checkout repository 34 | uses: actions/checkout@v4 35 | - uses: actions-rs/audit-check@v1 36 | with: 37 | token: ${{ secrets.GITHUB_TOKEN }} 38 | 39 | cargo_deny: 40 | permissions: 41 | issues: write # to create issues (actions-rs/audit-check) 42 | checks: write # to create check (actions-rs/audit-check) 43 | runs-on: ubuntu-latest 44 | strategy: 45 | matrix: 46 | checks: 47 | - bans licenses sources 48 | steps: 49 | - uses: actions/checkout@v4 50 | - uses: EmbarkStudios/cargo-deny-action@v2 51 | with: 52 | command: check ${{ matrix.checks }} 53 | rust-version: stable 54 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | permissions: 4 | contents: read 5 | 6 | on: 7 | pull_request: 8 | push: 9 | branches: 10 | - master 11 | 12 | env: 13 | RUST_BACKTRACE: 1 14 | CARGO_TERM_COLOR: always 15 | CLICOLOR: 1 16 | 17 | concurrency: 18 | group: "${{ github.workflow }}-${{ github.ref }}" 19 | cancel-in-progress: true 20 | 21 | jobs: 22 | ci: 23 | permissions: 24 | contents: none 25 | name: CI 26 | needs: [test, msrv, lockfile, docs, rustfmt, clippy, minimal-versions] 27 | runs-on: ubuntu-latest 28 | if: "always()" 29 | steps: 30 | - name: Failed 31 | run: exit 1 32 | if: "contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') || contains(needs.*.result, 'skipped')" 33 | test: 34 | name: Test 35 | strategy: 36 | matrix: 37 | os: ["ubuntu-latest", "windows-latest", "macos-latest"] 38 | rust: ["stable"] 39 | continue-on-error: ${{ matrix.rust != 'stable' }} 40 | runs-on: ${{ matrix.os }} 41 | steps: 42 | - name: Checkout repository 43 | uses: actions/checkout@v4 44 | - name: Install Rust 45 | uses: dtolnay/rust-toolchain@stable 46 | with: 47 | toolchain: ${{ matrix.rust }} 48 | - uses: Swatinem/rust-cache@v2 49 | - uses: taiki-e/install-action@cargo-hack 50 | - name: Build 51 | run: cargo test --workspace --no-run 52 | - name: Test 53 | run: cargo hack test --each-feature --workspace 54 | msrv: 55 | name: "Check MSRV" 56 | runs-on: ubuntu-latest 57 | steps: 58 | - name: Checkout repository 59 | uses: actions/checkout@v4 60 | - name: Install Rust 61 | uses: dtolnay/rust-toolchain@stable 62 | with: 63 | toolchain: stable 64 | - uses: Swatinem/rust-cache@v2 65 | - uses: taiki-e/install-action@cargo-hack 66 | - name: Default features 67 | run: cargo hack check --each-feature --locked --rust-version --ignore-private --workspace --all-targets --keep-going 68 | minimal-versions: 69 | name: Minimal versions 70 | runs-on: ubuntu-latest 71 | steps: 72 | - name: Checkout repository 73 | uses: actions/checkout@v4 74 | - name: Install stable Rust 75 | uses: dtolnay/rust-toolchain@stable 76 | with: 77 | toolchain: stable 78 | - name: Install nightly Rust 79 | uses: dtolnay/rust-toolchain@stable 80 | with: 81 | toolchain: nightly 82 | - name: Downgrade dependencies to minimal versions 83 | run: cargo +nightly generate-lockfile -Z minimal-versions 84 | - name: Compile with minimal versions 85 | run: cargo +stable check --workspace --all-features --locked --keep-going 86 | lockfile: 87 | runs-on: ubuntu-latest 88 | steps: 89 | - name: Checkout repository 90 | uses: actions/checkout@v4 91 | - name: Install Rust 92 | uses: dtolnay/rust-toolchain@stable 93 | with: 94 | toolchain: stable 95 | - uses: Swatinem/rust-cache@v2 96 | - name: "Is lockfile updated?" 97 | run: cargo update --workspace --locked 98 | docs: 99 | name: Docs 100 | runs-on: ubuntu-latest 101 | steps: 102 | - name: Checkout repository 103 | uses: actions/checkout@v4 104 | - name: Install Rust 105 | uses: dtolnay/rust-toolchain@stable 106 | with: 107 | toolchain: "1.87" # STABLE 108 | - uses: Swatinem/rust-cache@v2 109 | - name: Check documentation 110 | env: 111 | RUSTDOCFLAGS: -D warnings 112 | run: cargo doc --workspace --all-features --no-deps --document-private-items --keep-going 113 | rustfmt: 114 | name: rustfmt 115 | runs-on: ubuntu-latest 116 | steps: 117 | - name: Checkout repository 118 | uses: actions/checkout@v4 119 | - name: Install Rust 120 | uses: dtolnay/rust-toolchain@stable 121 | with: 122 | toolchain: "1.87" # STABLE 123 | components: rustfmt 124 | - uses: Swatinem/rust-cache@v2 125 | - name: Check formatting 126 | run: cargo fmt --all -- --check 127 | clippy: 128 | name: clippy 129 | runs-on: ubuntu-latest 130 | permissions: 131 | security-events: write # to upload sarif results 132 | steps: 133 | - name: Checkout repository 134 | uses: actions/checkout@v4 135 | - name: Install Rust 136 | uses: dtolnay/rust-toolchain@stable 137 | with: 138 | toolchain: "1.87" # STABLE 139 | components: clippy 140 | - uses: Swatinem/rust-cache@v2 141 | - name: Install SARIF tools 142 | run: cargo install clippy-sarif --locked 143 | - name: Install SARIF tools 144 | run: cargo install sarif-fmt --locked 145 | - name: Check 146 | run: > 147 | cargo clippy --workspace --all-features --all-targets --message-format=json 148 | | clippy-sarif 149 | | tee clippy-results.sarif 150 | | sarif-fmt 151 | continue-on-error: true 152 | - name: Upload 153 | uses: github/codeql-action/upload-sarif@v3 154 | with: 155 | sarif_file: clippy-results.sarif 156 | wait-for-processing: true 157 | - name: Report status 158 | run: cargo clippy --workspace --all-features --all-targets --keep-going -- -D warnings --allow deprecated 159 | coverage: 160 | name: Coverage 161 | runs-on: ubuntu-latest 162 | steps: 163 | - name: Checkout repository 164 | uses: actions/checkout@v4 165 | - name: Install Rust 166 | uses: dtolnay/rust-toolchain@stable 167 | with: 168 | toolchain: stable 169 | - uses: Swatinem/rust-cache@v2 170 | - name: Install cargo-tarpaulin 171 | run: cargo install cargo-tarpaulin 172 | - name: Gather coverage 173 | run: cargo tarpaulin --output-dir coverage --out lcov 174 | - name: Publish to Coveralls 175 | uses: coverallsapp/github-action@master 176 | with: 177 | github-token: ${{ secrets.GITHUB_TOKEN }} 178 | -------------------------------------------------------------------------------- /.github/workflows/committed.yml: -------------------------------------------------------------------------------- 1 | # Not run as part of pre-commit checks because they don't handle sending the correct commit 2 | # range to `committed` 3 | name: Lint Commits 4 | on: [pull_request] 5 | 6 | permissions: 7 | contents: read 8 | 9 | env: 10 | RUST_BACKTRACE: 1 11 | CARGO_TERM_COLOR: always 12 | CLICOLOR: 1 13 | 14 | concurrency: 15 | group: "${{ github.workflow }}-${{ github.ref }}" 16 | cancel-in-progress: true 17 | 18 | jobs: 19 | committed: 20 | name: Lint Commits 21 | runs-on: ubuntu-latest 22 | steps: 23 | - name: Checkout Actions Repository 24 | uses: actions/checkout@v4 25 | with: 26 | fetch-depth: 0 27 | - name: Lint Commits 28 | uses: crate-ci/committed@master 29 | -------------------------------------------------------------------------------- /.github/workflows/pre-commit.yml: -------------------------------------------------------------------------------- 1 | name: pre-commit 2 | 3 | permissions: {} # none 4 | 5 | on: 6 | pull_request: 7 | push: 8 | branches: [master] 9 | 10 | env: 11 | RUST_BACKTRACE: 1 12 | CARGO_TERM_COLOR: always 13 | CLICOLOR: 1 14 | 15 | concurrency: 16 | group: "${{ github.workflow }}-${{ github.ref }}" 17 | cancel-in-progress: true 18 | 19 | jobs: 20 | pre-commit: 21 | permissions: 22 | contents: read 23 | runs-on: ubuntu-latest 24 | steps: 25 | - uses: actions/checkout@v4 26 | - uses: actions/setup-python@v5 27 | with: 28 | python-version: '3.x' 29 | - uses: pre-commit/action@v3.0.1 30 | -------------------------------------------------------------------------------- /.github/workflows/rust-next.yml: -------------------------------------------------------------------------------- 1 | name: rust-next 2 | 3 | permissions: 4 | contents: read 5 | 6 | on: 7 | schedule: 8 | - cron: '9 9 9 * *' 9 | 10 | env: 11 | RUST_BACKTRACE: 1 12 | CARGO_TERM_COLOR: always 13 | CLICOLOR: 1 14 | 15 | concurrency: 16 | group: "${{ github.workflow }}-${{ github.ref }}" 17 | cancel-in-progress: true 18 | 19 | jobs: 20 | test: 21 | name: Test 22 | strategy: 23 | matrix: 24 | os: ["ubuntu-latest", "windows-latest", "macos-latest"] 25 | rust: ["stable", "beta"] 26 | include: 27 | - os: ubuntu-latest 28 | rust: "nightly" 29 | continue-on-error: ${{ matrix.rust != 'stable' }} 30 | runs-on: ${{ matrix.os }} 31 | steps: 32 | - name: Checkout repository 33 | uses: actions/checkout@v4 34 | - name: Install Rust 35 | uses: dtolnay/rust-toolchain@stable 36 | with: 37 | toolchain: ${{ matrix.rust }} 38 | - uses: Swatinem/rust-cache@v2 39 | - uses: taiki-e/install-action@cargo-hack 40 | - name: Build 41 | run: cargo test --workspace --no-run 42 | - name: Test 43 | run: cargo hack test --each-feature --workspace 44 | latest: 45 | name: "Check latest dependencies" 46 | runs-on: ubuntu-latest 47 | steps: 48 | - name: Checkout repository 49 | uses: actions/checkout@v4 50 | - name: Install Rust 51 | uses: dtolnay/rust-toolchain@stable 52 | with: 53 | toolchain: stable 54 | - uses: Swatinem/rust-cache@v2 55 | - uses: taiki-e/install-action@cargo-hack 56 | - name: Update dependencies 57 | run: cargo update 58 | - name: Build 59 | run: cargo test --workspace --no-run 60 | - name: Test 61 | run: cargo hack test --each-feature --workspace 62 | -------------------------------------------------------------------------------- /.github/workflows/spelling.yml: -------------------------------------------------------------------------------- 1 | name: Spelling 2 | 3 | permissions: 4 | contents: read 5 | 6 | on: [pull_request] 7 | 8 | env: 9 | RUST_BACKTRACE: 1 10 | CARGO_TERM_COLOR: always 11 | CLICOLOR: 1 12 | 13 | concurrency: 14 | group: "${{ github.workflow }}-${{ github.ref }}" 15 | cancel-in-progress: true 16 | 17 | jobs: 18 | spelling: 19 | name: Spell Check with Typos 20 | runs-on: ubuntu-latest 21 | steps: 22 | - name: Checkout Actions Repository 23 | uses: actions/checkout@v4 24 | - name: Spell Check Repo 25 | uses: crate-ci/typos@master 26 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | default_install_hook_types: ["pre-commit", "commit-msg"] 2 | repos: 3 | - repo: https://github.com/pre-commit/pre-commit-hooks 4 | rev: v5.0.0 5 | hooks: 6 | - id: check-yaml 7 | - id: check-json 8 | - id: check-toml 9 | - id: check-merge-conflict 10 | - id: check-case-conflict 11 | - id: detect-private-key 12 | - repo: https://github.com/crate-ci/typos 13 | rev: v1.32.0 14 | hooks: 15 | - id: typos 16 | - repo: https://github.com/crate-ci/committed 17 | rev: v1.1.7 18 | hooks: 19 | - id: committed 20 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | All notable changes to this project will be documented in this file. 3 | 4 | The format is based on [Keep a Changelog](http://keepachangelog.com/) 5 | and this project adheres to [Semantic Versioning](http://semver.org/). 6 | 7 | 8 | ## [Unreleased] - ReleaseDate 9 | 10 | ## [2.0.2] - 2024-07-25 11 | 12 | ### Compatibility 13 | 14 | - Updated MSRV to 1.74 15 | 16 | ## [2.0.1] - 2023-03-14 17 | 18 | ### Performance 19 | 20 | - Reduce code bloat 21 | 22 | ## [2.0.0] - 2022-10-04 23 | 24 | ### Breaking Changes 25 | 26 | - sysexits codes moved from `Code::*` to `sysexits::*` 27 | - bash codes moved from `Code::*` to `bash::*` 28 | - `ErrorKind` conversion requires `ToSysexitsResultExt::to_sysexits` 29 | - Removed `Display` for `Code` 30 | - Removed `is_reserved` 31 | - Changed default code to `FAILURE` 32 | - Renamed `Code::raw` to `Code::as_raw` 33 | - Removed `portable` feature forcing portable values when calling `std::process::exit` 34 | 35 | ### Compatibility 36 | 37 | MSRV is now 1.61.0 to integrate with `Termination` 38 | 39 | ### Features 40 | 41 | - Conversion from `Code` to `std::process::ExitCode` 42 | - `Termination` support 43 | 44 | ## [1.0.3] - 2021-12-28 45 | 46 | ### Fixes 47 | 48 | - Moved github orgs 49 | 50 | ## [1.0.2] - 2021-01-29 51 | 52 | ## [1.0.1] - 2020-11-23 53 | 54 | ## [1.0.0] - 2020-11-23 55 | 56 | ## [0.3.0] - 2020-11-23 57 | 58 | ### Fixes 59 | 60 | - Skip the extension trait, make `proc_exit::exit` the tool for `main`. 61 | 62 | ## [0.2.0] - 2020-11-21 63 | 64 | ### Fixes 65 | 66 | - Typos in documentation 67 | - `Exit`s members should not be public 68 | 69 | 70 | [Unreleased]: https://github.com/rust-cli/proc-exit/compare/v2.0.2...HEAD 71 | [2.0.2]: https://github.com/rust-cli/proc-exit/compare/v2.0.1...v2.0.2 72 | [2.0.1]: https://github.com/rust-cli/proc-exit/compare/v2.0.0...v2.0.1 73 | [2.0.0]: https://github.com/rust-cli/proc-exit/compare/v1.0.3...v2.0.0 74 | [1.0.3]: https://github.com/rust-cli/proc-exit/compare/v1.0.2...v1.0.3 75 | [1.0.2]: https://github.com/rust-cli/proc-exit/compare/v1.0.1...v1.0.2 76 | [1.0.1]: https://github.com/rust-cli/proc-exit/compare/v1.0.0...v1.0.1 77 | [1.0.0]: https://github.com/rust-cli/proc-exit/compare/v0.3.0...v1.0.0 78 | [0.3.0]: https://github.com/rust-cli/proc-exit/compare/v0.2.0...v0.3.0 79 | [0.2.0]: https://github.com/rust-cli/proc-exit/compare/v0.1.0...v0.2.0 80 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to proc-exit 2 | 3 | Thanks for wanting to contribute! There are many ways to contribute and we 4 | appreciate any level you're willing to do. 5 | 6 | ## Feature Requests 7 | 8 | Need some new functionality to help? You can let us know by opening an 9 | [issue][new issue]. It's helpful to look through [all issues][all issues] in 10 | case it's already being talked about. 11 | 12 | ## Bug Reports 13 | 14 | Please let us know about what problems you run into, whether in behavior or 15 | ergonomics of API. You can do this by opening an [issue][new issue]. It's 16 | helpful to look through [all issues][all issues] in case it's already being 17 | talked about. 18 | 19 | ## Pull Requests 20 | 21 | Looking for an idea? Check our [issues][issues]. If the issue looks open ended, 22 | it is probably best to post on the issue how you are thinking of resolving the 23 | issue so you can get feedback early in the process. We want you to be 24 | successful and it can be discouraging to find out a lot of re-work is needed. 25 | 26 | Already have an idea? It might be good to first [create an issue][new issue] 27 | to propose it so we can make sure we are aligned and lower the risk of having 28 | to re-work some of it and the discouragement that goes along with that. 29 | 30 | ### Process 31 | 32 | As a heads up, we'll be running your PR through the following gauntlet: 33 | - warnings turned to compile errors 34 | - `cargo test` 35 | - `rustfmt` 36 | - `clippy` 37 | - `rustdoc` 38 | - [`committed`](https://github.com/crate-ci/committed) as we use [Conventional](https://www.conventionalcommits.org) commit style 39 | - [`typos`](https://github.com/crate-ci/typos) to check spelling 40 | 41 | Not everything can be checked automatically though. 42 | 43 | We request that the commit history gets cleaned up. 44 | 45 | We ask that commits are atomic, meaning they are complete and have a single responsibility. 46 | A complete commit should build, pass tests, update documentation and tests, and not have dead code. 47 | 48 | PRs should tell a cohesive story, with refactor and test commits that keep the 49 | fix or feature commits simple and clear. 50 | 51 | Specifically, we would encourage 52 | - File renames be isolated into their own commit 53 | - Add tests in a commit before their feature or fix, showing the current behavior (i.e. they should pass). 54 | The diff for the feature/fix commit will then show how the behavior changed, 55 | making the commit's intent clearer to reviewers and the community, and showing people that the 56 | test is verifying the expected state. 57 | - e.g. [clap#5520](https://github.com/clap-rs/clap/pull/5520) 58 | 59 | Note that we are talking about ideals. 60 | We understand having a clean history requires more advanced git skills; 61 | feel free to ask us for help! 62 | We might even suggest where it would work to be lax. 63 | We also understand that editing some early commits may cause a lot of churn 64 | with merge conflicts which can make it not worth editing all of the history. 65 | 66 | For code organization, we recommend 67 | - Grouping `impl` blocks next to their type (or trait) 68 | - Grouping private items after the `pub` item that uses them. 69 | - The intent is to help people quickly find the "relevant" details, allowing them to "dig deeper" as needed. Or put another way, the `pub` items serve as a table-of-contents. 70 | - The exact order is fuzzy; do what makes sense 71 | 72 | ## Releasing 73 | 74 | Pre-requisites 75 | - Running `cargo login` 76 | - A member of `rust-cli:Maintainers` 77 | - Push permission to the repo 78 | - [`cargo-release`](https://github.com/crate-ci/cargo-release/) 79 | 80 | When we're ready to release, a project owner should do the following 81 | 1. Update the changelog (see `cargo release changes` for ideas) 82 | 2. Determine what the next version is, according to semver 83 | 3. Run [`cargo release -x `](https://github.com/crate-ci/cargo-release) 84 | 85 | [issues]: https://github.com/rust-cli/proc-exit/issues 86 | [new issue]: https://github.com/rust-cli/proc-exit/issues/new 87 | [all issues]: https://github.com/rust-cli/proc-exit/issues?utf8=%E2%9C%93&q=is%3Aissue 88 | -------------------------------------------------------------------------------- /Cargo.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Cargo. 2 | # It is not intended for manual editing. 3 | version = 3 4 | 5 | [[package]] 6 | name = "proc-exit" 7 | version = "2.0.2" 8 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [workspace] 2 | resolver = "2" 3 | 4 | [workspace.package] 5 | repository = "https://github.com/rust-cli/proc-exit" 6 | license = "MIT OR Apache-2.0" 7 | edition = "2021" 8 | rust-version = "1.74" # MSRV 9 | include = [ 10 | "build.rs", 11 | "src/**/*", 12 | "Cargo.toml", 13 | "Cargo.lock", 14 | "LICENSE*", 15 | "README.md", 16 | "examples/**/*" 17 | ] 18 | 19 | [workspace.lints.rust] 20 | rust_2018_idioms = { level = "warn", priority = -1 } 21 | unnameable_types = "warn" 22 | unreachable_pub = "warn" 23 | unsafe_op_in_unsafe_fn = "warn" 24 | unused_lifetimes = "warn" 25 | unused_macro_rules = "warn" 26 | unused_qualifications = "warn" 27 | 28 | [workspace.lints.clippy] 29 | bool_assert_comparison = "allow" 30 | branches_sharing_code = "allow" 31 | checked_conversions = "warn" 32 | collapsible_else_if = "allow" 33 | create_dir = "warn" 34 | dbg_macro = "warn" 35 | debug_assert_with_mut_call = "warn" 36 | doc_markdown = "warn" 37 | empty_enum = "warn" 38 | enum_glob_use = "warn" 39 | expl_impl_clone_on_copy = "warn" 40 | explicit_deref_methods = "warn" 41 | explicit_into_iter_loop = "warn" 42 | fallible_impl_from = "warn" 43 | filter_map_next = "warn" 44 | flat_map_option = "warn" 45 | float_cmp_const = "warn" 46 | fn_params_excessive_bools = "warn" 47 | from_iter_instead_of_collect = "warn" 48 | if_same_then_else = "allow" 49 | implicit_clone = "warn" 50 | imprecise_flops = "warn" 51 | inconsistent_struct_constructor = "warn" 52 | inefficient_to_string = "warn" 53 | infinite_loop = "warn" 54 | invalid_upcast_comparisons = "warn" 55 | large_digit_groups = "warn" 56 | large_stack_arrays = "warn" 57 | large_types_passed_by_value = "warn" 58 | let_and_return = "allow" # sometimes good to name what you are returning 59 | linkedlist = "warn" 60 | lossy_float_literal = "warn" 61 | macro_use_imports = "warn" 62 | mem_forget = "warn" 63 | mutex_integer = "warn" 64 | needless_continue = "allow" 65 | needless_for_each = "warn" 66 | negative_feature_names = "warn" 67 | path_buf_push_overwrite = "warn" 68 | ptr_as_ptr = "warn" 69 | rc_mutex = "warn" 70 | redundant_feature_names = "warn" 71 | ref_option_ref = "warn" 72 | rest_pat_in_fully_bound_structs = "warn" 73 | result_large_err = "allow" 74 | same_functions_in_if_condition = "warn" 75 | self_named_module_files = "warn" 76 | semicolon_if_nothing_returned = "warn" 77 | str_to_string = "warn" 78 | string_add = "warn" 79 | string_add_assign = "warn" 80 | string_lit_as_bytes = "warn" 81 | string_to_string = "warn" 82 | todo = "warn" 83 | trait_duplication_in_bounds = "warn" 84 | uninlined_format_args = "warn" 85 | verbose_file_reads = "warn" 86 | wildcard_imports = "warn" 87 | zero_sized_map_values = "warn" 88 | 89 | [profile.dev] 90 | panic = "abort" 91 | 92 | [profile.release] 93 | panic = "abort" 94 | codegen-units = 1 95 | lto = true 96 | # debug = "line-tables-only" # requires Cargo 1.71 97 | 98 | [package] 99 | name = "proc-exit" 100 | version = "2.0.2" 101 | description = "Exit codes for process termination" 102 | authors = ["Ed Page "] 103 | documentation = "https://docs.rs/proc-exit" 104 | readme = "README.md" 105 | categories = ["command-line-interface", "os"] 106 | keywords = ["cli", "exit-codes", "sysexit"] 107 | repository.workspace = true 108 | license.workspace = true 109 | edition.workspace = true 110 | rust-version.workspace = true 111 | include.workspace = true 112 | 113 | [package.metadata.docs.rs] 114 | all-features = true 115 | rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"] 116 | 117 | [package.metadata.release] 118 | pre-release-replacements = [ 119 | {file="CHANGELOG.md", search="Unreleased", replace="{{version}}", min=1}, 120 | {file="CHANGELOG.md", search="\\.\\.\\.HEAD", replace="...{{tag_name}}", exactly=1}, 121 | {file="CHANGELOG.md", search="ReleaseDate", replace="{{date}}", min=1}, 122 | {file="CHANGELOG.md", search="", replace="\n## [Unreleased] - ReleaseDate\n", exactly=1}, 123 | {file="CHANGELOG.md", search="", replace="\n[Unreleased]: https://github.com/rust-cli/proc-exit/compare/{{tag_name}}...HEAD", exactly=1}, 124 | ] 125 | [features] 126 | default = [] 127 | 128 | [dependencies] 129 | 130 | [dev-dependencies] 131 | 132 | [lints] 133 | workspace = true 134 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright (c) Individual contributors 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is 8 | furnished to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in all 11 | copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 19 | SOFTWARE. 20 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # proc-exit 2 | 3 | > Exit codes for process termination 4 | 5 | [![codecov](https://codecov.io/gh/rust-cli/proc-exit/branch/master/graph/badge.svg)](https://codecov.io/gh/rust-cli/proc-exit) 6 | [![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation] 7 | ![License](https://img.shields.io/crates/l/proc-exit.svg) 8 | [![Crates Status](https://img.shields.io/crates/v/proc-exit.svg)][Crates.io] 9 | 10 | ## Features 11 | 12 | - `i32` newtype for exit codes 13 | - Can represent any valid exit code 14 | - Type safe, operations are restricted to what is valid for exit codes 15 | - Includes standard exit codes and signal exit codes 16 | - Integrate with `main`, `std::process`, and `std::io::Error` 17 | - Supports exiting silently (error message reported through another means) 18 | 19 | ## Install 20 | 21 | Add to your `Cargo.toml`: 22 | 23 | ```console 24 | $ cargo add proc-exit 25 | ``` 26 | 27 | ## Relevant crates 28 | 29 | Other crates that might be useful in testing command line programs. 30 | - [duct][duct] for orchestrating multiple processes. 31 | - or [commandspec][commandspec] for easier writing of commands 32 | - [rexpect][rexpect] for controlling interactive programs. 33 | - [`assert_cmd`][assert_cmd] can be reused to simplify controlling CLIs 34 | 35 | [duct]: https://crates.io/crates/duct 36 | [rexpect]: https://crates.io/crates/rexpect 37 | [assert_cmd]: https://crates.io/crates/assert_cmd 38 | [commandspec]: https://crates.io/crates/commandspec 39 | 40 | ## Related crates 41 | 42 | Some crates that fill a similar role include: 43 | - [sysexit][sysexit] 44 | - Uses an enum, making certain states unpresentable 45 | - Includes signals 46 | - Integrates with `std::process` and `std::io::Error` 47 | - Doesn't integrate with `main` 48 | - [exit-code][exit-code] 49 | - `i32` constants and helper methods 50 | - Doesn't include signals 51 | - Doesn't integrate with `main`, `std::process`, or `std::io::Error` 52 | - [exitcode][exitcode] 53 | - `i32` constants and helper methods 54 | - Doesn't include signals 55 | - Doesn't integrate with `main`, `std::process`, or `std::io::Error` 56 | - [exitfailure][exitfailure] 57 | - Allows `Display`able errors to be used with [`?` in `main()`](https://github.com/rust-lang/rust/issues/43301) 58 | 59 | [sysexit]: https://crates.io/crates/sysexit 60 | [exit-code]: https://crates.io/crates/exit-code 61 | [exitcode]: https://crates.io/crates/exitcode 62 | [exitfailure]: https://crates.io/crates/exitfailure 63 | 64 | ## License 65 | 66 | Licensed under either of 67 | 68 | * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or ) 69 | * MIT license ([LICENSE-MIT](LICENSE-MIT) or ) 70 | 71 | at your option. 72 | 73 | ### Contribution 74 | 75 | Unless you explicitly state otherwise, any contribution intentionally 76 | submitted for inclusion in the work by you, as defined in the Apache-2.0 77 | license, shall be dual-licensed as above, without any additional terms or 78 | conditions. 79 | 80 | [Crates.io]: https://crates.io/crates/proc-exit 81 | [Documentation]: https://docs.rs/proc-exit 82 | -------------------------------------------------------------------------------- /committed.toml: -------------------------------------------------------------------------------- 1 | style="conventional" 2 | ignore_author_re="(dependabot|renovate)" 3 | merge_commit = false 4 | -------------------------------------------------------------------------------- /deny.toml: -------------------------------------------------------------------------------- 1 | # Note that all fields that take a lint level have these possible values: 2 | # * deny - An error will be produced and the check will fail 3 | # * warn - A warning will be produced, but the check will not fail 4 | # * allow - No warning or error will be produced, though in some cases a note 5 | # will be 6 | 7 | # Root options 8 | 9 | # The graph table configures how the dependency graph is constructed and thus 10 | # which crates the checks are performed against 11 | [graph] 12 | # If 1 or more target triples (and optionally, target_features) are specified, 13 | # only the specified targets will be checked when running `cargo deny check`. 14 | # This means, if a particular package is only ever used as a target specific 15 | # dependency, such as, for example, the `nix` crate only being used via the 16 | # `target_family = "unix"` configuration, that only having windows targets in 17 | # this list would mean the nix crate, as well as any of its exclusive 18 | # dependencies not shared by any other crates, would be ignored, as the target 19 | # list here is effectively saying which targets you are building for. 20 | targets = [ 21 | # The triple can be any string, but only the target triples built in to 22 | # rustc (as of 1.40) can be checked against actual config expressions 23 | #"x86_64-unknown-linux-musl", 24 | # You can also specify which target_features you promise are enabled for a 25 | # particular target. target_features are currently not validated against 26 | # the actual valid features supported by the target architecture. 27 | #{ triple = "wasm32-unknown-unknown", features = ["atomics"] }, 28 | ] 29 | # When creating the dependency graph used as the source of truth when checks are 30 | # executed, this field can be used to prune crates from the graph, removing them 31 | # from the view of cargo-deny. This is an extremely heavy hammer, as if a crate 32 | # is pruned from the graph, all of its dependencies will also be pruned unless 33 | # they are connected to another crate in the graph that hasn't been pruned, 34 | # so it should be used with care. The identifiers are [Package ID Specifications] 35 | # (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html) 36 | #exclude = [] 37 | # If true, metadata will be collected with `--all-features`. Note that this can't 38 | # be toggled off if true, if you want to conditionally enable `--all-features` it 39 | # is recommended to pass `--all-features` on the cmd line instead 40 | all-features = false 41 | # If true, metadata will be collected with `--no-default-features`. The same 42 | # caveat with `all-features` applies 43 | no-default-features = false 44 | # If set, these feature will be enabled when collecting metadata. If `--features` 45 | # is specified on the cmd line they will take precedence over this option. 46 | #features = [] 47 | 48 | # The output table provides options for how/if diagnostics are outputted 49 | [output] 50 | # When outputting inclusion graphs in diagnostics that include features, this 51 | # option can be used to specify the depth at which feature edges will be added. 52 | # This option is included since the graphs can be quite large and the addition 53 | # of features from the crate(s) to all of the graph roots can be far too verbose. 54 | # This option can be overridden via `--feature-depth` on the cmd line 55 | feature-depth = 1 56 | 57 | # This section is considered when running `cargo deny check advisories` 58 | # More documentation for the advisories section can be found here: 59 | # https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html 60 | [advisories] 61 | # The path where the advisory databases are cloned/fetched into 62 | #db-path = "$CARGO_HOME/advisory-dbs" 63 | # The url(s) of the advisory databases to use 64 | #db-urls = ["https://github.com/rustsec/advisory-db"] 65 | # A list of advisory IDs to ignore. Note that ignored advisories will still 66 | # output a note when they are encountered. 67 | ignore = [ 68 | #"RUSTSEC-0000-0000", 69 | #{ id = "RUSTSEC-0000-0000", reason = "you can specify a reason the advisory is ignored" }, 70 | #"a-crate-that-is-yanked@0.1.1", # you can also ignore yanked crate versions if you wish 71 | #{ crate = "a-crate-that-is-yanked@0.1.1", reason = "you can specify why you are ignoring the yanked crate" }, 72 | ] 73 | # If this is true, then cargo deny will use the git executable to fetch advisory database. 74 | # If this is false, then it uses a built-in git library. 75 | # Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support. 76 | # See Git Authentication for more information about setting up git authentication. 77 | #git-fetch-with-cli = true 78 | 79 | # This section is considered when running `cargo deny check licenses` 80 | # More documentation for the licenses section can be found here: 81 | # https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html 82 | [licenses] 83 | # List of explicitly allowed licenses 84 | # See https://spdx.org/licenses/ for list of possible licenses 85 | # [possible values: any SPDX 3.11 short identifier (+ optional exception)]. 86 | allow = [ 87 | "MIT", 88 | "MIT-0", 89 | "Apache-2.0", 90 | "BSD-2-Clause", 91 | "BSD-3-Clause", 92 | "MPL-2.0", 93 | "Unicode-DFS-2016", 94 | "CC0-1.0", 95 | "ISC", 96 | "OpenSSL", 97 | "Zlib", 98 | ] 99 | # The confidence threshold for detecting a license from license text. 100 | # The higher the value, the more closely the license text must be to the 101 | # canonical license text of a valid SPDX license file. 102 | # [possible values: any between 0.0 and 1.0]. 103 | confidence-threshold = 0.8 104 | # Allow 1 or more licenses on a per-crate basis, so that particular licenses 105 | # aren't accepted for every possible crate as with the normal allow list 106 | exceptions = [ 107 | # Each entry is the crate and version constraint, and its specific allow 108 | # list 109 | #{ allow = ["Zlib"], crate = "adler32" }, 110 | ] 111 | 112 | # Some crates don't have (easily) machine readable licensing information, 113 | # adding a clarification entry for it allows you to manually specify the 114 | # licensing information 115 | [[licenses.clarify]] 116 | # The package spec the clarification applies to 117 | crate = "ring" 118 | # The SPDX expression for the license requirements of the crate 119 | expression = "MIT AND ISC AND OpenSSL" 120 | # One or more files in the crate's source used as the "source of truth" for 121 | # the license expression. If the contents match, the clarification will be used 122 | # when running the license check, otherwise the clarification will be ignored 123 | # and the crate will be checked normally, which may produce warnings or errors 124 | # depending on the rest of your configuration 125 | license-files = [ 126 | # Each entry is a crate relative path, and the (opaque) hash of its contents 127 | { path = "LICENSE", hash = 0xbd0eed23 } 128 | ] 129 | 130 | [licenses.private] 131 | # If true, ignores workspace crates that aren't published, or are only 132 | # published to private registries. 133 | # To see how to mark a crate as unpublished (to the official registry), 134 | # visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field. 135 | ignore = true 136 | # One or more private registries that you might publish crates to, if a crate 137 | # is only published to private registries, and ignore is true, the crate will 138 | # not have its license(s) checked 139 | registries = [ 140 | #"https://sekretz.com/registry 141 | ] 142 | 143 | # This section is considered when running `cargo deny check bans`. 144 | # More documentation about the 'bans' section can be found here: 145 | # https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html 146 | [bans] 147 | # Lint level for when multiple versions of the same crate are detected 148 | multiple-versions = "warn" 149 | # Lint level for when a crate version requirement is `*` 150 | wildcards = "allow" 151 | # The graph highlighting used when creating dotgraphs for crates 152 | # with multiple versions 153 | # * lowest-version - The path to the lowest versioned duplicate is highlighted 154 | # * simplest-path - The path to the version with the fewest edges is highlighted 155 | # * all - Both lowest-version and simplest-path are used 156 | highlight = "all" 157 | # The default lint level for `default` features for crates that are members of 158 | # the workspace that is being checked. This can be overridden by allowing/denying 159 | # `default` on a crate-by-crate basis if desired. 160 | workspace-default-features = "allow" 161 | # The default lint level for `default` features for external crates that are not 162 | # members of the workspace. This can be overridden by allowing/denying `default` 163 | # on a crate-by-crate basis if desired. 164 | external-default-features = "allow" 165 | # List of crates that are allowed. Use with care! 166 | allow = [ 167 | #"ansi_term@0.11.0", 168 | #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is allowed" }, 169 | ] 170 | # List of crates to deny 171 | deny = [ 172 | #"ansi_term@0.11.0", 173 | #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is banned" }, 174 | # Wrapper crates can optionally be specified to allow the crate when it 175 | # is a direct dependency of the otherwise banned crate 176 | #{ crate = "ansi_term@0.11.0", wrappers = ["this-crate-directly-depends-on-ansi_term"] }, 177 | ] 178 | 179 | # List of features to allow/deny 180 | # Each entry the name of a crate and a version range. If version is 181 | # not specified, all versions will be matched. 182 | #[[bans.features]] 183 | #crate = "reqwest" 184 | # Features to not allow 185 | #deny = ["json"] 186 | # Features to allow 187 | #allow = [ 188 | # "rustls", 189 | # "__rustls", 190 | # "__tls", 191 | # "hyper-rustls", 192 | # "rustls", 193 | # "rustls-pemfile", 194 | # "rustls-tls-webpki-roots", 195 | # "tokio-rustls", 196 | # "webpki-roots", 197 | #] 198 | # If true, the allowed features must exactly match the enabled feature set. If 199 | # this is set there is no point setting `deny` 200 | #exact = true 201 | 202 | # Certain crates/versions that will be skipped when doing duplicate detection. 203 | skip = [ 204 | #"ansi_term@0.11.0", 205 | #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason why it can't be updated/removed" }, 206 | ] 207 | # Similarly to `skip` allows you to skip certain crates during duplicate 208 | # detection. Unlike skip, it also includes the entire tree of transitive 209 | # dependencies starting at the specified crate, up to a certain depth, which is 210 | # by default infinite. 211 | skip-tree = [ 212 | #"ansi_term@0.11.0", # will be skipped along with _all_ of its direct and transitive dependencies 213 | #{ crate = "ansi_term@0.11.0", depth = 20 }, 214 | ] 215 | 216 | # This section is considered when running `cargo deny check sources`. 217 | # More documentation about the 'sources' section can be found here: 218 | # https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html 219 | [sources] 220 | # Lint level for what to happen when a crate from a crate registry that is not 221 | # in the allow list is encountered 222 | unknown-registry = "deny" 223 | # Lint level for what to happen when a crate from a git repository that is not 224 | # in the allow list is encountered 225 | unknown-git = "deny" 226 | # List of URLs for allowed crate registries. Defaults to the crates.io index 227 | # if not specified. If it is specified but empty, no registries are allowed. 228 | allow-registry = ["https://github.com/rust-lang/crates.io-index"] 229 | # List of URLs for allowed Git repositories 230 | allow-git = [] 231 | 232 | [sources.allow-org] 233 | # 1 or more github.com organizations to allow git sources for 234 | github = [] 235 | # 1 or more gitlab.com organizations to allow git sources for 236 | gitlab = [] 237 | # 1 or more bitbucket.org organizations to allow git sources for 238 | bitbucket = [] 239 | -------------------------------------------------------------------------------- /release.toml: -------------------------------------------------------------------------------- 1 | owners = ["github:rust-cli:Maintainers"] 2 | allow-branch = ["master"] 3 | -------------------------------------------------------------------------------- /src/bash.rs: -------------------------------------------------------------------------------- 1 | //! Bash [exit codes](https://tldp.org/LDP/abs/html/exitcodes.html) 2 | 3 | /// Convert [`std::io::ErrorKind`] to a [`Code`][crate::Code] 4 | #[inline] 5 | pub fn io_to_signal(kind: std::io::ErrorKind) -> Option { 6 | match kind { 7 | std::io::ErrorKind::BrokenPipe => Some(SIGPIPE), 8 | std::io::ErrorKind::TimedOut => Some(SIGALRM), 9 | std::io::ErrorKind::Interrupted => Some(SIGINT), 10 | _ => None, 11 | } 12 | } 13 | 14 | /// Command line usage error 15 | /// 16 | /// While bash generally documents this as "Misuse of shell builtins (according to Bash 17 | /// documentation)", it is more broadly interpreted as a general usage error. 18 | pub const USAGE: crate::Code = crate::Code::new(2); 19 | 20 | /// Command was found but is not executable by the shell. 21 | pub const NOT_EXECUTABLE: crate::Code = crate::Code::new(126); 22 | 23 | /// Usually indicates that the command was not found by the shell, or that 24 | /// the command is found but that a library it requires is not found. 25 | pub const NOT_FOUND: crate::Code = crate::Code::new(127); 26 | 27 | /// Usually indicates that the command was not found by the shell, or that 28 | /// the command is found but that a library it requires is not found. 29 | pub const INVALID_EXIT: crate::Code = crate::Code::new(128); 30 | 31 | /// Exit status out of range 32 | /// 33 | /// `exit` takes only integer args in the range 0 - 255 34 | pub const STATUS_OUT_OF_RANGE: crate::Code = crate::Code::new(255); 35 | 36 | const SIGBASE: i32 = 128; 37 | 38 | /// The `SIGHUP` signal is sent to a process when its controlling terminal 39 | /// is closed. 40 | pub const SIGHUP: crate::Code = crate::Code::new(SIGBASE + 1); 41 | 42 | /// The `SIGINT` signal is sent to a process by its controlling terminal 43 | /// when a user wishes to interrupt the process. 44 | pub const SIGINT: crate::Code = crate::Code::new(SIGBASE + 2); 45 | 46 | /// The `SIGQUIT` signal is sent to a process by its controlling terminal 47 | /// when a user quit from keyboard (Ctrl-\. or, Ctrl-4 or, on the virtual console, the `SysRq` key) 48 | pub const SIGQUIT: crate::Code = crate::Code::new(SIGBASE + 3); 49 | 50 | /// The `SIGILL` signal is sent to a process by its controlling terminal 51 | /// when an illegal instruction is encountered 52 | pub const SIGILL: crate::Code = crate::Code::new(SIGBASE + 4); 53 | 54 | /// The `SIGTRAP` signal is sent to a process by its controlling terminal 55 | /// when there is a trace/breakpoint trap 56 | pub const SIGTRAP: crate::Code = crate::Code::new(SIGBASE + 5); 57 | 58 | /// The `SIGABRT` signal is sent to a process by its controlling terminal 59 | /// when process abort signal 60 | pub const SIGABRT: crate::Code = crate::Code::new(SIGBASE + 6); 61 | 62 | /// The `SIGFPE` signal is sent to a process by its controlling terminal 63 | /// when there is an erroneous arithmetic operation 64 | pub const SIGFPE: crate::Code = crate::Code::new(SIGBASE + 8); 65 | 66 | /// The `SIGKILL` signal is sent to a process to cause it to terminate 67 | /// immediately. In contrast to `SIGTERM` and `SIGINT`, this signal cannot 68 | /// be caught or ignored, and the receiving process cannot perform any 69 | /// clean-up upon receiving this signal. 70 | pub const SIGKILL: crate::Code = crate::Code::new(SIGBASE + 9); 71 | 72 | /// The `SIGSEGV` signal is sent to a process on invalid memory reference 73 | pub const SIGSEGV: crate::Code = crate::Code::new(SIGBASE + 11); 74 | 75 | /// The `SIGPIPE` signal is sent to a process when it attempts to write to 76 | /// a pipe without a process connected to the other end. 77 | pub const SIGPIPE: crate::Code = crate::Code::new(SIGBASE + 13); 78 | 79 | /// The `SIGALRM` signal is sent to a process when the time limit specified 80 | /// in a call to a preceding alarm setting function (such as `setitimer`) 81 | /// elapses. 82 | pub const SIGALRM: crate::Code = crate::Code::new(SIGBASE + 14); 83 | 84 | /// The `SIGTERM` signal is sent to a process to request its termination. 85 | /// Unlike the `SIGKILL` signal, it can be caught and interpreted or 86 | /// ignored by the process. 87 | pub const SIGTERM: crate::Code = crate::Code::new(SIGBASE + 15); 88 | -------------------------------------------------------------------------------- /src/code.rs: -------------------------------------------------------------------------------- 1 | /// Process exit code. 2 | /// 3 | /// Common exit codes: 4 | /// - [`Code::SUCCESS`] 5 | /// - [`Code::FAILURE`] 6 | /// - [`bash::USAGE`][crate::bash::USAGE] 7 | #[derive(Clone, Copy, Debug, Eq, PartialEq)] 8 | pub struct Code(i32); 9 | 10 | /// # Create a [`Code`] 11 | impl Code { 12 | /// The process exited successfully. 13 | pub const SUCCESS: Code = Code(0); 14 | 15 | /// Generic failure. 16 | pub const FAILURE: Code = Code(1); 17 | 18 | /// Create a custom error code 19 | pub const fn new(code: i32) -> Self { 20 | Self(code) 21 | } 22 | 23 | /// Converts [`std::process::ExitStatus`] to [`Code`]. 24 | /// 25 | /// On Unix, if the process was terminated by a fatal signal, the corresponding 26 | /// signal exit code is returned. 27 | #[inline] 28 | pub fn from_status(status: std::process::ExitStatus) -> Self { 29 | Self::from(status) 30 | } 31 | } 32 | 33 | /// # Bubble up the exit [`Code`] 34 | impl Code { 35 | /// [`exit`][std::process::exit] now! 36 | #[inline] 37 | pub fn process_exit(self) -> ! { 38 | std::process::exit(self.as_raw()) 39 | } 40 | 41 | /// Convert to [`Result`] 42 | #[inline] 43 | pub fn ok(self) -> crate::ExitResult { 44 | if self.as_raw() == Self::SUCCESS.as_raw() { 45 | Ok(()) 46 | } else { 47 | Err(crate::Exit::new(self)) 48 | } 49 | } 50 | 51 | /// Convert to [`Exit`][crate::Exit] error type 52 | #[inline] 53 | pub fn as_exit(self) -> crate::Exit { 54 | crate::Exit::new(self) 55 | } 56 | 57 | /// Add user-visible message (like an [`Error`][std::error::Error]) 58 | #[inline] 59 | pub fn with_message(self, msg: D) -> crate::Exit { 60 | self.as_exit().with_message(msg) 61 | } 62 | } 63 | 64 | /// # Introspection and Integration 65 | impl Code { 66 | /// Convert to [`ExitCode`][std::process::ExitCode] 67 | #[inline] 68 | pub fn as_exit_code(self) -> Option { 69 | self.as_portable().map(|c| c.into()) 70 | } 71 | 72 | /// Convert to raw value 73 | #[inline] 74 | pub const fn as_raw(self) -> i32 { 75 | self.0 76 | } 77 | 78 | /// Convert to portable, raw value 79 | #[inline] 80 | pub const fn as_portable(self) -> Option { 81 | if self.is_portable() { 82 | Some(self.as_raw() as u8) 83 | } else { 84 | None 85 | } 86 | } 87 | 88 | /// Determines if the provided [`std::process::ExitStatus`] was successful. 89 | /// 90 | /// Example: 91 | /// 92 | /// ``` 93 | /// use std::process; 94 | /// 95 | /// let exit_status = process::Command::new("true") 96 | /// .status() 97 | /// .expect("failed to run true(1)"); 98 | /// assert!(proc_exit::Code::from_status(exit_status).is_ok()); 99 | /// ``` 100 | /// 101 | #[inline] 102 | pub const fn is_ok(self) -> bool { 103 | self.as_raw() == Self::SUCCESS.as_raw() 104 | } 105 | 106 | /// Determines if the provided [`std::process::ExitStatus`] was unsuccessful. 107 | /// 108 | /// Example: 109 | /// 110 | /// ``` 111 | /// use std::process; 112 | /// 113 | /// let exit_status = process::Command::new("false") 114 | /// .status() 115 | /// .expect("failed to run false(1)"); 116 | /// assert!(proc_exit::Code::from_status(exit_status).is_err()); 117 | /// ``` 118 | /// 119 | #[inline] 120 | pub const fn is_err(self) -> bool { 121 | !self.is_ok() 122 | } 123 | 124 | /// Test if provided exit code is portable across platforms. 125 | /// 126 | /// While Windows has wider types for return codes, Unix OS's tend to only support 8-bits, 127 | /// stripping off the higher order bits. 128 | #[inline] 129 | pub const fn is_portable(self) -> bool { 130 | 0 <= self.as_raw() && self.as_raw() <= 255 131 | } 132 | } 133 | 134 | impl Default for Code { 135 | #[inline] 136 | fn default() -> Self { 137 | // Chosen to allow `coerce().unwrap_or_default` 138 | Self::FAILURE 139 | } 140 | } 141 | 142 | /// Converts an `i32` primitive integer to an exit code. 143 | impl From for Code { 144 | #[inline] 145 | fn from(n: i32) -> Self { 146 | Self(n) 147 | } 148 | } 149 | 150 | /// Converts [`std::process::ExitStatus`] to an exit code by looking at its 151 | /// [`ExitStatus::code()`] value. 152 | /// 153 | /// On Unix, if the process was terminated by a fatal signal, the corresponding 154 | /// signal exit code is returned. 155 | /// 156 | /// [`std::process::ExitStatus`]: 157 | /// https://doc.rust-lang.org/std/process/struct.ExitStatus.html 158 | /// [`ExitStatus::code()`]: 159 | /// https://doc.rust-lang.org/std/process/struct.ExitStatus.html#method.code 160 | impl From for Code { 161 | #[inline] 162 | fn from(status: std::process::ExitStatus) -> Self { 163 | let n = platform_exit_code(status).unwrap_or(Code::default().0); 164 | From::from(n) 165 | } 166 | } 167 | 168 | #[cfg(target_family = "unix")] 169 | #[inline] 170 | fn platform_exit_code(status: std::process::ExitStatus) -> Option { 171 | use std::os::unix::process::ExitStatusExt; 172 | status.code().or_else(|| status.signal()) 173 | } 174 | 175 | #[cfg(not(target_family = "unix"))] 176 | #[inline] 177 | fn platform_exit_code(status: std::process::ExitStatus) -> Option { 178 | status.code() 179 | } 180 | 181 | impl std::process::Termination for Code { 182 | #[inline] 183 | fn report(self) -> std::process::ExitCode { 184 | self.as_exit_code() 185 | .unwrap_or(std::process::ExitCode::FAILURE) 186 | } 187 | } 188 | -------------------------------------------------------------------------------- /src/exit.rs: -------------------------------------------------------------------------------- 1 | use std::io::Write; 2 | 3 | /// For use in `fn run() -> ExitResult {}` 4 | pub type ExitResult = Result<(), Exit>; 5 | 6 | /// Error type for exiting programs. 7 | pub struct Exit { 8 | code: crate::Code, 9 | msg: Option>, 10 | } 11 | 12 | impl Exit { 13 | #[inline] 14 | pub fn new(code: crate::Code) -> Self { 15 | Self { code, msg: None } 16 | } 17 | 18 | #[inline] 19 | pub fn with_message(mut self, msg: D) -> Self { 20 | self.msg = Some(Box::new(msg)); 21 | self 22 | } 23 | } 24 | 25 | impl std::fmt::Display for Exit { 26 | #[inline] 27 | fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { 28 | if let Some(msg) = self.msg.as_ref() { 29 | msg.fmt(f) 30 | } else { 31 | Ok(()) 32 | } 33 | } 34 | } 35 | 36 | impl std::process::Termination for Exit { 37 | #[inline] 38 | fn report(self) -> std::process::ExitCode { 39 | self.code 40 | .as_exit_code() 41 | .unwrap_or(std::process::ExitCode::FAILURE) 42 | } 43 | } 44 | 45 | impl std::fmt::Debug for Exit { 46 | #[inline] 47 | fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { 48 | // For compatibility with `std::process::Termination` 49 | std::fmt::Display::fmt(self, f) 50 | } 51 | } 52 | 53 | /// Extension for converting errors to `Exit`. 54 | pub trait WithCodeResultExt { 55 | /// Convert an Error into an `Exit` 56 | fn with_code(self, code: crate::Code) -> Result; 57 | } 58 | 59 | impl WithCodeResultExt for Result { 60 | #[inline] 61 | fn with_code(self, code: crate::Code) -> Result { 62 | self.map_err(|e| Exit::new(code).with_message(e)) 63 | } 64 | } 65 | 66 | /// Report any error message and exit. 67 | #[inline] 68 | pub fn exit(result: ExitResult) -> ! { 69 | let code = report(result); 70 | code.process_exit() 71 | } 72 | 73 | /// Report, delegating exiting to the caller. 74 | #[inline] 75 | pub fn report(result: ExitResult) -> crate::Code { 76 | match result { 77 | Ok(()) => crate::Code::SUCCESS, 78 | Err(err) => { 79 | if let Some(msg) = err.msg { 80 | // At this point, we might be exiting due to a broken pipe, just do our best and 81 | // move on. 82 | let _ = writeln!(std::io::stderr(), "{msg}"); 83 | } 84 | err.code 85 | } 86 | } 87 | } 88 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | //! ## Features 2 | //! 3 | //! - `i32` newtype for exit codes 4 | //! - Can represent any valid exit code 5 | //! - Type safe, operations are restricted to what is valid for exit codes 6 | //! - Includes common exit codes and signal exit codes 7 | //! - Integrate with `main`, `std::process`, and `std::io::Error` 8 | //! - Supports exiting silently (error message reported through another means) 9 | //! 10 | //! ## Install 11 | //! 12 | //! Add to your `Cargo.toml`: 13 | //! 14 | //! ```console 15 | //! $ cargo add proc-exit 16 | //! ``` 17 | //! 18 | //! # Example 19 | //! 20 | //! ``` 21 | //! use proc_exit::prelude::*; 22 | //! 23 | //! fn main() { 24 | //! // Simple but Macro-less `main` 25 | //! // - Fast compiles 26 | //! // - Composable with other features 27 | //! let result = run(); 28 | //! proc_exit::exit(result); 29 | //! } 30 | //! 31 | //! fn run() -> proc_exit::ExitResult { 32 | //! // Integrates directly with `std::io::Error`, returning the right exit code. 33 | //! let exit_status = std::process::Command::new("true") 34 | //! .status().with_code(proc_exit::Code::FAILURE)?; 35 | //! // Can pass `Command` exit codes right up, when appropriate 36 | //! proc_exit::Code::from_status(exit_status).ok()?; 37 | //! 38 | //! proc_exit::Code::SUCCESS.ok() 39 | //! } 40 | //! ``` 41 | //! 42 | //! ## Relevant CLI crates 43 | //! 44 | //! Other crates that might be useful in testing command line programs. 45 | //! - [duct][duct] for orchestrating multiple processes. 46 | //! - or [commandspec][commandspec] for easier writing of commands 47 | //! - [rexpect][rexpect] for controlling interactive programs. 48 | //! - [`assert_cmd`][assert_cmd] can be reused to simplify controlling CLIs 49 | //! 50 | //! [duct]: https://crates.io/crates/duct 51 | //! [rexpect]: https://crates.io/crates/rexpect 52 | //! [assert_cmd]: https://crates.io/crates/assert_cmd 53 | //! [commandspec]: https://crates.io/crates/commandspec 54 | //! 55 | //! ## Alternative crates 56 | //! 57 | //! Crates considered when making this one include: 58 | //! - [sysexit][sysexit] 59 | //! - Uses an enum, making certain states unrepresentable 60 | //! - Includes signals 61 | //! - Integrates with `std::process` and `std::io::Error` 62 | //! - Doesn't integrate with `main` 63 | //! - [sysexits] 64 | //! - Uses an enum, making certain states unrepresentable 65 | //! - Doesn't include signals 66 | //! - Doesn't integrate with `main`, `std::process`, or `std::io::Error` 67 | //! - [exit-code][exit-code] 68 | //! - `i32` constants and helper methods 69 | //! - Doesn't include signals 70 | //! - Doesn't integrate with `main`, `std::process`, or `std::io::Error` 71 | //! - [exitcode][exitcode] 72 | //! - `i32` constants and helper methods 73 | //! - Doesn't include signals 74 | //! - Doesn't integrate with `main`, `std::process`, or `std::io::Error` 75 | //! - [exitfailure][exitfailure] 76 | //! - Allows `Display`able errors to be used with [`?` in `main()`](https://github.com/rust-lang/rust/issues/43301) 77 | //! 78 | //! [sysexit]: https://crates.io/crates/sysexit 79 | //! [exit-code]: https://crates.io/crates/exit-code 80 | //! [exitcode]: https://crates.io/crates/exitcode 81 | //! [exitfailure]: https://crates.io/crates/exitfailure 82 | 83 | #![cfg_attr(docsrs, feature(doc_auto_cfg))] 84 | #![warn(clippy::print_stderr)] 85 | #![warn(clippy::print_stdout)] 86 | 87 | mod code; 88 | mod exit; 89 | 90 | /// Easy access to traits 91 | pub mod prelude { 92 | pub use super::WithCodeResultExt as _; 93 | pub use crate::sysexits::ToSysexitsResultExt as _; 94 | } 95 | 96 | pub mod bash; 97 | pub mod sysexits; 98 | 99 | pub use code::Code; 100 | pub use exit::WithCodeResultExt; 101 | pub use exit::{exit, report}; 102 | pub use exit::{Exit, ExitResult}; 103 | 104 | #[doc = include_str!("../README.md")] 105 | #[cfg(doctest)] 106 | pub struct ReadmeDoctests; 107 | -------------------------------------------------------------------------------- /src/sysexits.rs: -------------------------------------------------------------------------------- 1 | //! Support for [sysexits](https://www.freebsd.org/cgi/man.cgi?query=sysexits) codes 2 | //! 3 | //! Note: [FreeBSD no longer encourages these](https://reviews.freebsd.org/D27176) 4 | 5 | /// Extension for converting errors to [`Exit`][crate::Exit] 6 | /// 7 | /// # Example 8 | /// 9 | /// ``` 10 | /// use proc_exit::prelude::*; 11 | /// 12 | /// fn main() { 13 | /// // Simple but Macro-less `main` 14 | /// // - Fast compiles 15 | /// // - Composable with other features 16 | /// let result = run(); 17 | /// proc_exit::exit(result); 18 | /// } 19 | /// 20 | /// fn run() -> proc_exit::ExitResult { 21 | /// // Integrates directly with `std::io::Error`, returning the right exit code. 22 | /// let exit_status = std::process::Command::new("true") 23 | /// .status().to_sysexits()?; 24 | /// // Can pass `Command` exit codes right up, when appropriate 25 | /// proc_exit::Code::from_status(exit_status).ok()?; 26 | /// 27 | /// proc_exit::Code::SUCCESS.ok() 28 | /// } 29 | /// ``` 30 | pub trait ToSysexitsResultExt { 31 | /// Convert an Error into an [`Exit`][crate::Exit] 32 | fn to_sysexits(self) -> Result; 33 | } 34 | 35 | impl ToSysexitsResultExt for Result { 36 | #[inline] 37 | fn to_sysexits(self) -> Result { 38 | self.map_err(|e| { 39 | let kind = e.kind(); 40 | let code = io_to_sysexists(kind) 41 | .or_else(|| crate::bash::io_to_signal(kind)) 42 | .unwrap_or(IO_ERR); 43 | crate::Exit::new(code).with_message(e) 44 | }) 45 | } 46 | } 47 | 48 | /// Convert [`std::io::ErrorKind`] to a [`Code`][crate::Code] 49 | #[inline] 50 | pub fn io_to_sysexists(kind: std::io::ErrorKind) -> Option { 51 | match kind { 52 | std::io::ErrorKind::NotFound => Some(OS_FILE_ERR), 53 | std::io::ErrorKind::PermissionDenied => Some(NO_PERM), 54 | std::io::ErrorKind::ConnectionRefused 55 | | std::io::ErrorKind::ConnectionReset 56 | | std::io::ErrorKind::ConnectionAborted 57 | | std::io::ErrorKind::NotConnected => Some(PROTOCOL_ERR), 58 | std::io::ErrorKind::AddrInUse | std::io::ErrorKind::AddrNotAvailable => { 59 | Some(SERVICE_UNAVAILABLE) 60 | } 61 | std::io::ErrorKind::AlreadyExists => Some(CANT_CREAT), 62 | std::io::ErrorKind::InvalidInput 63 | | std::io::ErrorKind::InvalidData 64 | | std::io::ErrorKind::UnexpectedEof => Some(DATA_ERR), 65 | std::io::ErrorKind::WriteZero => Some(NO_INPUT), 66 | _ => None, 67 | } 68 | } 69 | 70 | /// The process exited successfully. 71 | pub const OK: crate::Code = crate::Code::new(0); 72 | 73 | /// The command was used incorrectly, e.g. with the wrong number of 74 | /// arguments, a bad flag, bad syntax in a parameter, or whatever. 75 | pub const USAGE_ERR: crate::Code = crate::Code::new(64); 76 | 77 | /// The input data was incorrect in some way. This should only be used for 78 | /// user’s data and not system files. 79 | pub const DATA_ERR: crate::Code = crate::Code::new(65); 80 | 81 | /// An input file (not a system file) did not exist or was not readable. 82 | /// This could also include errors like “No message” to a mailer (if it 83 | /// cared to catch it). 84 | pub const NO_INPUT: crate::Code = crate::Code::new(66); 85 | 86 | /// The user specified did not exist. This might be used for mail addresses 87 | /// or remote logins. 88 | pub const NO_USER: crate::Code = crate::Code::new(67); 89 | 90 | /// The host specified did not exist. This is used in mail addresses or 91 | /// network requests. 92 | pub const NO_HOST: crate::Code = crate::Code::new(68); 93 | 94 | /// A service is unavailable. This can occur if a support program or file 95 | /// does not exist. This can also be used as a catch-all message when 96 | /// something you wanted to do doesn’t work, but you don’t know why. 97 | pub const SERVICE_UNAVAILABLE: crate::Code = crate::Code::new(69); 98 | 99 | /// An internal software error has been detected. This should be limited 100 | /// to non-operating system related errors if possible. 101 | pub const SOFTWARE_ERR: crate::Code = crate::Code::new(70); 102 | 103 | /// An operating system error has been detected. This is intended to be 104 | /// used for such things as “cannot fork”, or “cannot create pipe”. It 105 | /// includes things like [getuid(2)] returning a user that does not exist 106 | /// in the passwd file. 107 | /// 108 | /// [getuid(2)]: https://man.openbsd.org/getuid.2 109 | pub const OS_ERR: crate::Code = crate::Code::new(71); 110 | 111 | /// Some system file (e.g. _/etc/passwd_, _/var/run/utmp_) does not exist, 112 | /// cannot be opened, or has some sort of error (e.g. syntax error). 113 | pub const OS_FILE_ERR: crate::Code = crate::Code::new(72); 114 | 115 | /// A (user specified) output file cannot be created. 116 | pub const CANT_CREAT: crate::Code = crate::Code::new(73); 117 | 118 | /// An error occurred while doing I/O on some file. 119 | pub const IO_ERR: crate::Code = crate::Code::new(74); 120 | 121 | /// Temporary failure, indicating something that is not really an error. 122 | /// For example that a mailer could not create a connection, and the 123 | /// request should be reattempted later. 124 | pub const TEMP_FAIL: crate::Code = crate::Code::new(75); 125 | 126 | /// The remote system returned something that was “not possible” during a 127 | /// protocol exchange. 128 | pub const PROTOCOL_ERR: crate::Code = crate::Code::new(76); 129 | 130 | /// You did not have sufficient permission to perform the operation. This 131 | /// is not intended for file system problems, which should use `NoInput` or 132 | /// `CantCreat`, but rather for high level permissions. 133 | pub const NO_PERM: crate::Code = crate::Code::new(77); 134 | 135 | /// Something was found in an unconfigured or misconfigured state. 136 | pub const CONFIG_ERR: crate::Code = crate::Code::new(78); 137 | --------------------------------------------------------------------------------