Google Git
Sign in
android / platform / external / rust / crates / nix / refs/heads/android14-qpr3-s15-release
commit9a2c95d28202cd3a8c66db81749a3a6128cc5ffe[log] [tgz]
authorAndroid Build Coastguard Worker <[email protected]>Wed Jan 17 00:22:35 2024 +0000
committerAndroid Build Coastguard Worker <[email protected]>Wed Jan 17 00:22:35 2024 +0000
tree433bf4bf96250b2f15312c2150f82d3ea71052dd
parenta5bbc91279b28755aadb64f8a5669b2c0b5e43a9 [diff]
parentd50a5572c10b3a555ba7d7c89e64a82cea2f577e [diff]
Snap for 11317273 from d50a5572c10b3a555ba7d7c89e64a82cea2f577e to 24Q2-release

Change-Id: I166c18b59d08aa5a7a6f17845d84725c6fe6a23d
tree: 433bf4bf96250b2f15312c2150f82d3ea71052dd
  1. patches/
  2. src/
  3. test/
  4. .cargo_vcs_info.json
  5. .gitignore
  6. Android.bp
  7. Cargo.toml
  8. Cargo.toml.orig
  9. cargo_embargo.json
  10. CHANGELOG.md
  11. LICENSE
  12. METADATA
  13. MODULE_LICENSE_MIT
  14. OWNERS
  15. README.md
  16. TEST_MAPPING
README.md

Rust bindings to *nix APIs

Cirrus Build Status crates.io

Documentation (Releases)

Nix seeks to provide friendly bindings to various *nix platform APIs (Linux, Darwin, ...). The goal is to not provide a 100% unified interface, but to unify what can be while still providing platform specific APIs.

For many system APIs, Nix provides a safe alternative to the unsafe APIs exposed by the libc crate. This is done by wrapping the libc functionality with types/abstractions that enforce legal/safe usage.

As an example of what Nix provides, examine the differences between what is exposed by libc and nix for the gethostname system call:

// libc api (unsafe, requires handling return code/errno)
pub unsafe extern fn gethostname(name: *mut c_char, len: size_t) -> c_int;

// nix api (returns a nix::Result<OsString>)
pub fn gethostname() -> Result<OsString>;

Supported Platforms

nix target support consists of three tiers. While nix attempts to support all platforms supported by libc, only some platforms are actively supported due to either technical or manpower limitations. Support for platforms is split into three tiers:

  • Tier 1 - Builds and tests for this target are run in CI. Failures of either block the inclusion of new code.
  • Tier 2 - Builds for this target are run in CI. Failures during the build blocks the inclusion of new code. Tests may be run, but failures in tests don't block the inclusion of new code.
  • Tier 3 - Builds for this target are run in CI. Failures during the build do not necessarily block the inclusion of new code. That is, at our discretion a Tier 3 target may be dropped at any time, if it would otherwise block development.

Platforms not listed are supported on a best-effort basis, relying on our users to report any problems.

The following targets are supported by nix:

Minimum Supported Rust Version (MSRV)

nix is supported on Rust 1.65 and higher. Its MSRV will not be changed in the future without bumping the major or minor version.

Contributing

Contributions are very welcome. Please See CONTRIBUTING for additional details.

Feel free to join us in the nix-rust/nix channel on Gitter to discuss nix development.

License

Nix is licensed under the MIT license. See LICENSE for more details.