https://github.com/sorairolake/sysexits-rs
The system exit codes as defined by <sysexits.h> for Rust
https://github.com/sorairolake/sysexits-rs
exitcode rust rust-lang rust-library sysexits
Last synced: about 1 month ago
JSON representation
The system exit codes as defined by <sysexits.h> for Rust
- Host: GitHub
- URL: https://github.com/sorairolake/sysexits-rs
- Owner: sorairolake
- License: apache-2.0
- Created: 2022-05-28T19:50:57.000Z (almost 3 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-27T13:26:57.000Z (about 2 months ago)
- Last Synced: 2025-03-30T06:03:25.190Z (about 2 months ago)
- Topics: exitcode, rust, rust-lang, rust-library, sysexits
- Language: Rust
- Homepage: https://docs.rs/sysexits
- Size: 360 KB
- Stars: 27
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.adoc
- Contributing: CONTRIBUTING.adoc
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Authors: AUTHORS.adoc
Awesome Lists containing this project
- awesome-rust - sorairolake/sysexits-rs - rs/workflows/CI/badge.svg?branch=develop)](https://github.com/sorairolake/sysexits-rs/actions?query=workflow%3ACI) (Libraries / System)
README
# sysexits-rs
[![CI][ci-badge]][ci-url]
[![Version][version-badge]][version-url]
![MSRV][msrv-badge]
[![Docs][docs-badge]][docs-url]
![License][license-badge]
[![REUSE status][reuse-badge]][reuse-url]
**sysexits-rs** ([`sysexits`][version-url]) is a library that provides the
system exit code constants as defined by [``].
This library implements the [`Termination`] trait, so this can be returned from
the `main` function.
## Usage
Run the following command in your project directory:
```sh
cargo add sysexits
```
### Crate features
#### `extended_io_error`
Enables features that depend on the `io_error_inprogress` and the
`io_error_more` features. This also enables `std`. This is implied by `nightly`.
#### `nightly`
Enables features that depend on the nightly Rust.
#### `std`
Enables features that depend on the standard library. This is enabled by
default.
### `no_std` support
This supports `no_std` mode. Disables the `default` feature to enable this.
### Documentation
See the [documentation][docs-url] for more details.
## Minimum supported Rust version
The minimum supported Rust version (MSRV) of this library is v1.85.0.
## Source code
The upstream repository is available at
.
The source code is also available at:
-
-
## Changelog
Please see [CHANGELOG.adoc].
## Contributing
Please see [CONTRIBUTING.adoc].
## Similar projects
- (Julia)
- (Zig)
You can discover more projects at
.
## License
Copyright (C) 2022 Shun Sakai and other contributors (see [AUTHORS.adoc])
This library is distributed under the terms of either the _Apache License 2.0_
or the _MIT License_.
This project is compliant with version 3.3 of the [_REUSE Specification_]. See
copyright notices of individual files for more details on copyright and
licensing information.
[ci-badge]: https://img.shields.io/github/actions/workflow/status/sorairolake/sysexits-rs/CI.yaml?branch=develop&style=for-the-badge&logo=github&label=CI
[ci-url]: https://github.com/sorairolake/sysexits-rs/actions?query=branch%3Adevelop+workflow%3ACI++
[version-badge]: https://img.shields.io/crates/v/sysexits?style=for-the-badge&logo=rust
[version-url]: https://crates.io/crates/sysexits
[msrv-badge]: https://img.shields.io/crates/msrv/sysexits?style=for-the-badge&logo=rust
[docs-badge]: https://img.shields.io/docsrs/sysexits?style=for-the-badge&logo=docsdotrs&label=Docs.rs
[docs-url]: https://docs.rs/sysexits
[license-badge]: https://img.shields.io/crates/l/sysexits?style=for-the-badge
[reuse-badge]: https://img.shields.io/reuse/compliance/github.com%2Fsorairolake%2Fsysexits-rs?style=for-the-badge
[reuse-url]: https://api.reuse.software/info/github.com/sorairolake/sysexits-rs
[``]: https://man.openbsd.org/sysexits
[`Termination`]: https://doc.rust-lang.org/std/process/trait.Termination.html
[CHANGELOG.adoc]: CHANGELOG.adoc
[CONTRIBUTING.adoc]: CONTRIBUTING.adoc
[AUTHORS.adoc]: AUTHORS.adoc
[_REUSE Specification_]: https://reuse.software/spec-3.3/