Module rustix::io

I/O operations.

Modules

epoll

epoll support.

Structs

DupFlags

O_* constants for use with dup2.

Errno

errno—An error code.

EventfdFlags

EFD_* flags for use with eventfd.

FdFlags

FD_* constants for use with fcntl_getfd and fcntl_setfd.

IoSlice

A buffer type used with Write::write_vectored.

IoSliceMut

A buffer type used with Read::read_vectored.

IoSliceRaw

A buffer type used with vmsplice. It is guaranteed to be ABI compatible with the iovec type on Unix platforms and WSABUF on Windows. Unlike IoSlice and IoSliceMut it is semantically like a raw pointer, and therefore can be shared or mutated as needed.

PipeFlags

O_* constants for use with pipe_with.

PollFd

struct pollfd—File descriptor and flags for use with poll.

PollFlags

POLL* flags for use with poll.

ReadWriteFlags

RWF_* constants for use with preadv2 and pwritev2. RWF_* constants for use with preadv2 and pwritev2.

SpliceFlags

SPLICE_F_* constants for use with [splice] and [vmsplice].

Enums

SeekFrom

Enumeration of possible methods to seek within an I/O object.

Constants

PIPE_BUF

PIPE_BUF—The maximum length at which writes to a pipe are atomic.

Functions

close^⚠

close(raw_fd)—Closes a RawFd directly.

dup

dup(fd)—Creates a new OwnedFd instance that shares the same underlying file description as fd.

dup2

dup2(fd, new)—Changes the file description of a file descriptor.

dup3

dup3(fd, new, flags)—Changes the file description of a file descriptor, with flags.

eventfd

eventfd(initval, flags)—Creates a file descriptor for event notification.

fcntl_dupfd_cloexec

fcntl(fd, F_DUPFD_CLOEXEC)—Creates a new OwnedFd instance, with value at least min, that has O_CLOEXEC set and that shares the same underlying [file description] as fd.

fcntl_getfd

fcntl(fd, F_GETFD)—Returns a file descriptor’s flags.

fcntl_setfd

fcntl(fd, F_SETFD, flags)—Sets a file descriptor’s flags.

ioctl_blkpbszget

ioctl(fd, BLKPBSZGET)—Returns the physical block size of a block device.

ioctl_blksszget

ioctl(fd, BLKSSZGET)—Returns the logical block size of a block device.

ioctl_fionbio

ioctl(fd, FIONBIO, &value)—Enables or disables non-blocking mode.

ioctl_fionread

ioctl(fd, FIONREAD)—Returns the number of bytes ready to be read.

ioctl_tiocexcl

ioctl(fd, TIOCEXCL)—Enables exclusive mode on a terminal.

ioctl_tiocnxcl

ioctl(fd, TIOCNXCL)—Disables exclusive mode on a terminal.

is_read_writefs and net

Returns a pair of booleans indicating whether the file descriptor is readable and/or writable, respectively.

pipe

pipe()—Creates a pipe.

pipe_with

pipe2(flags)—Creates a pipe, with flags.

poll

poll(self.fds, timeout)

pread

pread(fd, buf, offset)—Reads from a file at a given position.

preadv

preadv(fd, bufs, offset)—Reads from a file at a given position into multiple buffers.

preadv2

preadv2(fd, bufs, offset, flags)—Reads data, with several options.

proc_self_fdprocfs

Returns a handle to Linux’s /proc/self/fd directory.

proc_self_fdinfo_fdprocfs

Returns a handle to a Linux /proc/self/fdinfo/<fd> file.

proc_self_mapsprocfs

Returns a handle to a Linux /proc/self/maps file.

proc_self_pagemapprocfs

Returns a handle to a Linux /proc/self/pagemap file.

proc_self_statusprocfs

Returns a handle to a Linux /proc/self/status file.

pwrite

pwrite(fd, bufs)—Writes to a file at a given position.

pwritev

pwritev(fd, bufs, offset)—Writes to a file at a given position from multiple buffers.

pwritev2

pwritev2(fd, bufs, offset, flags)—Writes data, with several options.

raw_stderr

STDERR_FILENO—Standard error, raw.

raw_stdin

STDIN_FILENO—Standard input, raw.

raw_stdout

STDOUT_FILENO—Standard output, raw.

read

read(fd, buf)—Reads from a stream.

readv

readv(fd, bufs)—Reads from a stream into multiple buffers.

retry_on_intr

Call f until it either succeeds or fails other than Errno::INTR.

splice

splice(fd_in, off_in, fd_out, off_out, len, flags)—Transfer data between a file and a pipe.

stderr^⚠

STDERR_FILENO—Standard error, borrowed.

stdin^⚠

STDIN_FILENO—Standard input, borrowed.

stdout^⚠

STDOUT_FILENO—Standard output, borrowed.

take_stderr^⚠

STDERR_FILENO—Standard error, owned.

take_stdin^⚠

STDIN_FILENO—Standard input, owned.

take_stdout^⚠

STDOUT_FILENO—Standard output, owned.

vmsplice^⚠

vmsplice(fd, bufs, flags)—Transfer data between memory and a pipe.

write

write(fd, buf)—Writes to a stream.

writev

writev(fd, bufs)—Writes to a stream from multiple buffers.

Type Definitions

Result

A specialized Result type for rustix APIs.