#unix #linux #macos #osx #bsd

uapi

Wrappers for OS APIs on UNIX-like platform

15 releases

0.2.10 Jun 24, 2022
0.2.9 Apr 11, 2022
0.2.7 Feb 15, 2022
0.2.4 Dec 30, 2021
0.1.3 May 30, 2020

#86 in Unix APIs

Download history 51/week @ 2022-03-14 45/week @ 2022-03-21 4/week @ 2022-03-28 13/week @ 2022-04-04 62/week @ 2022-04-11 12/week @ 2022-04-18 105/week @ 2022-04-25 181/week @ 2022-05-02 37/week @ 2022-05-09 276/week @ 2022-05-16 88/week @ 2022-05-23 173/week @ 2022-05-30 55/week @ 2022-06-06 6/week @ 2022-06-13 35/week @ 2022-06-20 37/week @ 2022-06-27

165 downloads per month
Used in clone3

MIT/Apache

180KB
5K SLoC

Unix API

crates.io docs.rs

This crate contains safe wrappers around Unix APIs.

Supported Targets

A target is supported if and only if the crate is tested against it via CI.

The following targets are supported:

  • x86_64-unknown-linux-gnu (glibc >= 2.23)
  • x86_64-unknown-linux-musl (musl >= 1.1.19)
  • x86_64-unknown-freebsd (12)
  • x86_64-unknown-openbsd (6.7)
  • x86_64-apple-darwin (10.15)

This crate contains little architecture-specific code. Therefore, other architectures (arm, aarch64, etc.) will probably also work.

Future changes

This crate fully supports reading into uninitialized buffers but the API will most likely change when the same functionality becomes stable in libstd.

Comparison with other crates

libc

This crate builds on the libc crate and uses its declarations of the raw OS APIs if possible. This crate considers itself to be the next step up from libc: It safely wraps the raw OS functions but does little beyond that. Integer parameters are still integer parameters, functions operating on sockets accept the socket file descriptor as a raw integer, there is no socket wrapper type, etc.

At the same time, this crate provides the necessary tools to make it as easy to use from Rust as the raw APIs are to use from C. For example, all of the following just work:

open("./file", c::O_RDWR, 0);
open(b"./file", c::O_RDWR, 0);
open(CStr::from_ptr(p), c::O_RDWR, 0);
open(Path::new("./file"), c::O_RDWR, 0);

See the crate documentation for more details.

nix

  • nix uses a nested module structure. uapi exports all APIs in the crate root.
  • nix I/O works on [u8]. uapi I/O works on [MaybeUninit<u8>].
  • nix uses enums and bitflags for integer/flag parameters. uapi uses plain integers.
  • nix uses methods declared on wrapper types to expose APIs. uapi uses free functions unless doing so would be unsafe.
  • nix uses enums for the values produced and consumed by certain generic OS APIs (e.g. control messages.) uapi uses generic functions that do not restrict the types that can be used.

License

This project is licensed under either of

  • Apache License, Version 2.0
  • MIT License

at your option.

Dependencies

~1.2–2.1MB
~56K SLoC