Struct OpenFiles 

pub struct OpenFiles { /* private fields */ }

Represents the open files in a shell context.

Implementations

impl OpenFiles

pub const STDIN_FD: ShellFd = 0i32

File descriptor used for standard input.

pub const STDOUT_FD: ShellFd = 1i32

File descriptor used for standard output.

pub const STDERR_FD: ShellFd = 2i32

File descriptor used for standard error.

pub fn update_from(&mut self, files: impl Iterator<Item = (ShellFd, OpenFile)>)

Updates the open files from the provided iterator of (fd number, OpenFile) pairs. Any existing entries for the provided file descriptors will be overwritten.

Arguments

• files: An iterator of (fd number, OpenFile) pairs to update the open files with.

pub fn try_stdin(&self) -> Option<&OpenFile>

Retrieves the file backing standard input in this context.

pub fn try_stdout(&self) -> Option<&OpenFile>

Retrieves the file backing standard output in this context.

pub fn try_stderr(&self) -> Option<&OpenFile>

Retrieves the file backing standard error in this context.

pub fn remove_fd(&mut self, fd: ShellFd) -> Option<OpenFile>

Tries to remove an open file by its file descriptor. If the file descriptor is not used, None will be returned; otherwise, the removed file will be returned.

Arguments:

• fd: The file descriptor to remove.

pub fn try_fd(&self, fd: ShellFd) -> Option<&OpenFile>

Tries to lookup the OpenFile associated with a file descriptor. Returns None if the file descriptor is not present.

Arguments:

• fd: The file descriptor to lookup.

pub fn fd_entry(&self, fd: ShellFd) -> OpenFileEntry<'_>

Tries to lookup the OpenFile associated with a file descriptor. Returns an OpenFileEntry representing the state of the file descriptor.

Arguments:

• fd: The file descriptor to lookup.

pub fn contains_fd(&self, fd: ShellFd) -> bool

Checks if the given file descriptor is in use.

pub fn set_fd(&mut self, fd: ShellFd, file: OpenFile) -> Option<OpenFile>

Associates the given file descriptor with the provided file. If the file descriptor is already in use, the previous file will be returned; otherwise, None will be returned.

Arguments:

• fd: The file descriptor to associate with the file.
• file: The file to associate with the file descriptor.

pub fn iter_fds(&self) -> impl Iterator<Item = (ShellFd, &OpenFile)>

Iterates over all file descriptors.

Trait Implementations

impl Clone for OpenFiles

fn clone(&self) -> OpenFiles

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for OpenFiles

fn default() -> OpenFiles

Returns the “default value” for a type.

impl<I> From<I> for OpenFiles

where I: Iterator<Item = (ShellFd, OpenFile)>,

fn from(iter: I) -> Self

Converts to this type from the input type.