Google Git
Sign in
android / platform / external / rust / crates / nix / HEAD
commit675f4f597c594f89c7950a4b3cc804b567818fb5[log] [tgz]
authorJames Farrell <[email protected]>Tue Oct 08 21:25:26 2024 +0000
committerJames Farrell <[email protected]>Tue Oct 08 21:25:26 2024 +0000
tree26d624fb7e79b77c1753cb3c9e380ac3b15841af
parent42da12035e9ba0333957b98adec695046ecf2b06 [diff]
Migrate 25 crates to monorepo

itoa
percent-encoding
untrusted
arbitrary
nix
arc-swap
arrayvec
axum-core
bindgen-cli
cov-mark
equivalent
fixedbitset
foreign-types
foreign-types-shared
fxhash
http
hyper
kernlog
lazycell
libtest-mimic
libz-sys
merge
merge_derive
mls-rs
mls-rs-crypto-traits

Bug: http://b/339424309
Test: treehugger
Change-Id: I5263449cecbe91c292432c6f5d5fb727d118689c
3 files changed
tree: 26d624fb7e79b77c1753cb3c9e380ac3b15841af
  1. patches/
  2. src/
  3. test/
  4. .cargo_vcs_info.json
  5. .gitignore
  6. Android.bp
  7. build.rs
  8. Cargo.toml
  9. Cargo.toml.orig
  10. CHANGELOG.md
  11. LICENSE
  12. METADATA
  13. module_block.bp.fragment
  14. MODULE_LICENSE_MIT
  15. OWNERS
  16. README.md
README.md

Rust bindings to *nix APIs

Cirrus Build Status crates.io maintenance-status

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.69 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.