Skip to content
Rust friendly bindings to *nix APIs
Branch: master
Clone or download
bors and keur Merge #1042
1042: pty: Add forkpty r=asomers a=keur



Co-authored-by: Kevin Kuehler <keur@ocf.berkeley.edu>
Latest commit 71b35a0 Apr 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ci Support building and testing multiple targets at once Dec 9, 2017
src pty: Add forkpty Apr 23, 2019
test pty: Add forkpty Apr 23, 2019
.cirrus.yml Switch FreeBSD CI builds from BuildBot to cirrus-ci.com Dec 29, 2018
.gitattributes use better merge algorithm for CHANGELOG.md Sep 4, 2017
.gitignore
.travis.yml Require Rust 1.24.1 Nov 5, 2018
CHANGELOG.md pty: Add forkpty Apr 23, 2019
CONTRIBUTING.md ci: Allow skipping tests when running under CI Apr 17, 2017
CONVENTIONS.md
Cargo.toml Bump the rand dependency to 0.6 Feb 12, 2019
Cross.toml Use single threads for testing Jul 3, 2017
LICENSE Add a license file Feb 2, 2015
README.md
RELEASE_PROCEDURE.md Update release procedure Jun 2, 2018
bors.toml Switch FreeBSD CI builds from BuildBot to cirrus-ci.com Dec 29, 2018
build.rs Replace the gcc crate by cc Mar 28, 2018

README.md

Rust bindings to *nix APIs

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 all supported by nix on Rust 1.24.1 or newer (unless otherwise noted):

Tier 1:

  • aarch64-unknown-linux-gnu
  • arm-unknown-linux-gnueabi
  • armv7-unknown-linux-gnueabihf
  • i686-apple-darwin
  • 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
  • powerpc64-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-ios
  • aarch64-linux-android
  • arm-linux-androideabi
  • arm-unknown-linux-musleabi
  • armv7-apple-ios
  • armv7-linux-androideabi
  • armv7s-apple-ios
  • i386-apple-ios
  • i686-linux-android
  • powerpc-unknown-linux-gnu
  • s390x-unknown-linux-gnu
  • x86_64-apple-ios
  • x86_64-linux-android
  • x86_64-unknown-netbsd

Usage

To use nix, first add this to your Cargo.toml:

[dependencies]
nix = "0.13.0"

Then, add this to your crate root:

extern crate nix;

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.

You can’t perform that action at this time.