Go to file
Jan Bujak 4ae4cfd058 Make uname always safe
This fixes several issues with the current `uname` bindings:

  - Do not ignore `uname` errors; at least on glibc `uname` can fail,
    so now it returns a `Result` instead of assuming that the call
    will always succeed.

  - Do not assume `uname` will initialize every member of `utsname`;
    not every implementation initializes every field, so internally
    the struct is now zero-initialized.

  - Do not blindly assume strings returned by `uname` will always be valid UTF-8;
    `UtsName`'s accessors will now return `&OsStr`s instead of `&str`s.
2022-03-23 14:28:37 +09:00
src Make uname always safe 2022-03-23 14:28:37 +09:00
test Make uname always safe 2022-03-23 14:28:37 +09:00
.cirrus.yml Add support for aarch64-apple-darwin 2022-01-29 23:39:21 -06:00
.gitattributes use better merge algorithm for CHANGELOG.md 2017-09-04 10:43:15 +01:00
.gitignore 30X performance improvement in with_nix_path by not initializing memory 2022-02-13 13:32:52 -08:00
bors.toml Add support for aarch64-apple-darwin 2022-01-29 23:39:21 -06:00
Cargo.lock.msrv Re-enable deprecation warnings on DragonFly 2022-01-12 22:03:55 -06:00
Cargo.toml Redox renamed sigaction.sa_handler to .sa_sigaction 2022-03-20 09:24:21 -05:00
CHANGELOG.md Make uname always safe 2022-03-23 14:28:37 +09:00
CONTRIBUTING.md Fix CONTRIBUTING.md formating 2021-07-15 10:37:36 +00:00
CONVENTIONS.md Replace most instances of mem::uninitialized with mem::MaybeUninit 2019-09-03 16:25:41 -06:00
Cross.toml Ignore vsock tests on Linux aarch64 2021-08-27 22:31:20 -06:00
LICENSE Add a license file 2015-02-02 10:51:34 -08:00
README.md Add support for aarch64-apple-darwin 2022-01-29 23:39:21 -06:00
RELEASE_PROCEDURE.md [skip ci] Update cargo-release syntax in the docs 2021-12-16 19:00:34 -07:00
release.toml Remove no-dev-version flag 2021-12-17 09:46:42 -06:00

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<CStr>)
pub fn gethostname<'a>(buffer: &'a mut [u8]) -> Result<&'a CStr>;

Supported Platforms

nix target support consists of two 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 block the inclusion of new code. Testing may be run, but failures in tests don't block the inclusion of new code.

The following targets are supported by nix:

Tier 1:

  • aarch64-unknown-linux-gnu
  • arm-unknown-linux-gnueabi
  • armv7-unknown-linux-gnueabihf
  • i686-unknown-freebsd
  • i686-unknown-linux-gnu
  • i686-unknown-linux-musl
  • mips-unknown-linux-gnu
  • mips64-unknown-linux-gnuabi64
  • mips64el-unknown-linux-gnuabi64
  • mipsel-unknown-linux-gnu
  • powerpc64le-unknown-linux-gnu
  • x86_64-apple-darwin
  • x86_64-unknown-freebsd
  • x86_64-unknown-linux-gnu
  • x86_64-unknown-linux-musl

Tier 2:

  • aarch64-apple-darwin
  • aarch64-apple-ios
  • aarch64-linux-android
  • arm-linux-androideabi
  • arm-unknown-linux-musleabi
  • armv7-linux-androideabi
  • i686-linux-android
  • powerpc-unknown-linux-gnu
  • s390x-unknown-linux-gnu
  • x86_64-apple-ios
  • x86_64-linux-android
  • x86_64-unknown-illumos
  • x86_64-unknown-netbsd

Tier 3:

  • armv7-unknown-linux-uclibceabihf
  • x86_64-fuchsia
  • x86_64-unknown-dragonfly
  • x86_64-unknown-linux-gnux32
  • x86_64-unknown-openbsd
  • x86_64-unknown-redox

Minimum Supported Rust Version (MSRV)

nix is supported on Rust 1.46.0 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.