Skip to content
/ nix Public
forked from nix-rust/nix

Rust friendly bindings to *nix APIs

License

Notifications You must be signed in to change notification settings

inglorion/nix

This branch is 1 commit ahead of, 86 commits behind nix-rust/nix:master.

Folders and files

NameName
Last commit message
Last commit date
Jun 24, 2024
Jul 22, 2024
Nov 26, 2023
Jul 30, 2024
Jul 30, 2024
Jun 6, 2024
Sep 4, 2017
Feb 13, 2022
May 24, 2024
Dec 8, 2023
Apr 10, 2024
Jul 22, 2024
Aug 28, 2021
Feb 2, 2015
Jun 5, 2024
May 25, 2024
May 5, 2024
Jun 23, 2022
Oct 7, 2023

Repository files navigation

Rust bindings to *nix APIs

Cirrus Build Status crates.io docs.rs maintenance-status msrv

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:

Tier 1 Tier 2 Tier 3
  • aarch64-apple-darwin
  • 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-unknown-freebsd
  • x86_64-unknown-linux-gnu
  • x86_64-unknown-linux-musl
  • aarch64-apple-ios
  • aarch64-linux-android
  • arm-linux-androideabi
  • arm-unknown-linux-musleabi
  • armv7-linux-androideabi
  • i686-linux-android
  • s390x-unknown-linux-gnu
  • x86_64-linux-android
  • x86_64-unknown-illumos
  • x86_64-unknown-netbsd
  • armv7-unknown-linux-uclibceabihf
  • powerpc64-unknown-linux-gnu
  • x86_64-fuchsia
  • x86_64-unknown-dragonfly
  • x86_64-unknown-haiku
  • x86_64-unknown-linux-gnux32
  • x86_64-unknown-openbsd
  • x86_64-unknown-redox
  • i686-unknown-hurd-gnu
  • 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.

    About

    Rust friendly bindings to *nix APIs

    Resources

    License

    Stars

    Watchers

    Forks

    Releases

    No releases published

    Packages

    No packages published

    Languages

    • Rust 100.0%