Struct FdTable 

pub struct FdTable { /* private fields */ }

An FdTable is a table of file descriptors.

Implementations

impl FdTable

pub fn id(&self) -> FdTableId

Returns the FdTableId of the FdTable.

pub fn fork(&self) -> FdTable

Returns new unshared FdTable that is a snapshot of the state of the FdTable.

pub fn unshare(&self)

Ensures that this FdTable is not shared by any other FdTable instances.

pub fn release(&self)

Releases the FdTable, closing any files opened exclusively by this table.

pub fn exec(&self)

Trims close-on-exec file descriptors from the table.

pub fn insert<L>( &self, locked: &mut Locked<L>, task: &Task, fd: FdNumber, file: FileHandle, ) -> Result<(), Errno>

where L: LockBefore<ThreadGroupLimits>,

Inserts a file descriptor into the table.

pub fn insert_with_flags<L>( &self, locked: &mut Locked<L>, task: &Task, fd: FdNumber, file: FileHandle, flags: FdFlags, ) -> Result<(), Errno>

where L: LockBefore<ThreadGroupLimits>,

Inserts a file descriptor into the table with the specified flags.

pub fn add_with_flags<L>( &self, locked: &mut Locked<L>, task: &Task, file: FileHandle, flags: FdFlags, ) -> Result<FdNumber, Errno>

where L: LockBefore<ThreadGroupLimits>,

Adds a file descriptor to the table.

The file descriptor will be assigned the next available number.

Returns the assigned file descriptor number.

This function is the most common way to add a file descriptor to the table.

pub fn duplicate<L>( &self, locked: &mut Locked<L>, task: &Task, oldfd: FdNumber, target: TargetFdNumber, flags: FdFlags, ) -> Result<FdNumber, Errno>

where L: LockBefore<ThreadGroupLimits>,

Duplicates a file descriptor.

If target is TargetFdNumber::Minimum, a new FdNumber is allocated. Returns the new FdNumber.

pub fn get_allowing_opath(&self, fd: FdNumber) -> Result<FileHandle, Errno>

Returns the file handle associated with the given file descriptor.

Returns the file handle even if the file was opened with O_PATH.

This operation is uncommon. Most clients should use get instead, which fails if the file was opened with O_PATH.

pub fn get_allowing_opath_with_flags( &self, fd: FdNumber, ) -> Result<(FileHandle, FdFlags), Errno>

Returns the file handle and flags associated with the given file descriptor.

Returns the file handle even if the file was opened with O_PATH.

This operation is uncommon. Most clients should use get instead, which fails if the file was opened with O_PATH.

pub fn get(&self, fd: FdNumber) -> Result<FileHandle, Errno>

Returns the file handle associated with the given file descriptor.

This operation fails if the file was opened with O_PATH.

pub fn close(&self, fd: FdNumber) -> Result<(), Errno>

Closes the file descriptor associated with the given file descriptor.

This operation fails if the file descriptor is not valid.

pub fn get_fd_flags_allowing_opath( &self, fd: FdNumber, ) -> Result<FdFlags, Errno>

Returns the flags associated with the given file descriptor.

Returns the flags even if the file was opened with O_PATH.

pub fn set_fd_flags(&self, fd: FdNumber, flags: FdFlags) -> Result<(), Errno>

Sets the flags associated with the given file descriptor.

This operation fails if the file descriptor was opened with O_PATH or is not valid.

pub fn set_fd_flags_allowing_opath( &self, fd: FdNumber, flags: FdFlags, ) -> Result<(), Errno>

Sets the flags associated with the given file descriptor.

This operation fails if the file descriptor is not valid.

pub fn retain<F>(&self, predicate: F)

where F: Fn(FdNumber, &mut FdFlags) -> bool,

Retains only the FDs matching the given predicate.

The predicate is called with the FdNumber and a mutable reference to the FdFlags for each entry in the FdTable. If the predicate returns false, the entry is removed from the FdTable. Otherwise, the FdFlags are updated to the value modified by the predicate.

pub fn get_all_fds(&self) -> Vec<FdNumber>

Returns a vector of all current file descriptors in the table.

pub fn remap<F: Fn(&FileHandle) -> Option<FileHandle>>(&self, predicate: F)

Executes predicate(file) => maybe_replacement on every non-empty table entry.

Replaces file with replacement_file in the table when maybe_replacement == Some(replacement_file).

Trait Implementations

impl Clone for FdTable

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FdTable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FdTable

fn default() -> FdTable

Returns the “default value” for a type.