Crate `nix`

Rust friendly bindings to the various *nix system functions.

Modules are structured according to the C header file that they would be defined in.

Features

Nix uses the following Cargo features to enable optional functionality. They may be enabled in any combination.

acct - Process accounting
aio - POSIX AIO
dir - Stuff relating to directory iteration
env - Manipulate environment variables
event - Event-driven APIs, like kqueue and epoll
fanotify - Linux's fanotify filesystem events monitoring API
feature - Query characteristics of the OS at runtime
fs - File system functionality
hostname - Get and set the system's hostname
inotify - Linux's inotify file system notification API
ioctl - The ioctl syscall, and wrappers for many specific instances
kmod - Load and unload kernel modules
mman - Stuff relating to memory management
mount - Mount and unmount file systems
mqueue - POSIX message queues
net - Networking-related functionality
personality - Set the process execution domain
poll - APIs like poll and select
process - Stuff relating to running processes
pthread - POSIX threads
ptrace - Process tracing and debugging
quota - File system quotas
reboot - Reboot the system
resource - Process resource limits
sched - Manipulate process's scheduling
socket - Sockets, whether for networking or local use
signal - Send and receive signals to processes
syslog - System logging
term - Terminal control APIs
time - Query the operating system's clocks
ucontext - User thread context
uio - Vectored I/O
user - Stuff relating to users and groups
zerocopy - APIs like sendfile and copy_file_range

Modules

errno Safe wrappers around errno functions
fcntl File control options
libc
poll Wait for events to trigger on specific file descriptors
pty Create master and slave virtual pseudo-terminals (PTYs)
spawn Safe wrappers around posix_spawn* functions found in the libc "spawn.h" header.
sys Mostly platform-specific functionality
unistd Safe wrappers around functions found in libc "unistd.h" header

Traits

NixPath Common trait used to represent file system paths by many Nix functions.

Type Aliases

Error Nix's main error type.
Result Nix Result Type

Macros

ioctl_none Generates a wrapper function for an ioctl that passes no data to the kernel.
ioctl_none_bad Generates a wrapper function for a "bad" ioctl that passes no data to the kernel.
ioctl_read Generates a wrapper function for an ioctl that reads data from the kernel.
ioctl_read_bad Generates a wrapper function for a "bad" ioctl that reads data from the kernel.
ioctl_read_buf Generates a wrapper function for an ioctl that reads an array of elements from the kernel.
ioctl_readwrite Generates a wrapper function for an ioctl that reads and writes data to the kernel.
ioctl_readwrite_bad Generates a wrapper function for a "bad" ioctl that reads and writes data to the kernel.
ioctl_readwrite_buf Generates a wrapper function for an ioctl that reads and writes an array of elements to the kernel.
ioctl_write_buf Generates a wrapper function for an ioctl that writes an array of elements to the kernel.
ioctl_write_int Generates a wrapper function for a ioctl that writes an integer to the kernel.
ioctl_write_int_bad Generates a wrapper function for a "bad" ioctl that writes an integer to the kernel.
ioctl_write_ptr Generates a wrapper function for an ioctl that writes data through a pointer to the kernel.
ioctl_write_ptr_bad Generates a wrapper function for a "bad" ioctl that writes data through a pointer to the kernel.
request_code_none Generate an ioctl request code for a command that passes no data.
request_code_read Generate an ioctl request code for a command that reads.
request_code_readwrite Generate an ioctl request code for a command that reads and writes.
request_code_write Generate an ioctl request code for a command that writes.