Struct RealSystem 

pub struct RealSystem(/* private fields */);

Implementation of system traits that actually interact with the underlying system

RealSystem is an empty struct because the underlying operating system manages the system’s internal state.

Some trait methods implemented by RealSystem (such as SendSignal::kill) return futures, but the returned futures do not perform asynchronous operations. Those methods block the current thread until the underlying system calls complete and then return ready futures. See also the system module documentation.

Implementations

impl RealSystem

pub unsafe fn new() -> Self

Returns an instance of RealSystem.

Safety

This function is marked unsafe because improper use of RealSystem may lead to undefined behavior. Remember that most operations performed on the system by Env are not thread-safe. You should never use RealSystem in a multi-threaded program, and it is your responsibility to make sure you are using only one instance of ReadSystem in the process.

Trait Implementations

impl CaughtSignals for RealSystem

fn caught_signals(&self) -> Vec<Number>

Returns signals this process has caught, if any.

impl Chdir for RealSystem

fn chdir(&self, path: &CStr) -> Result<()>

Changes the working directory.

impl Clock for RealSystem

fn now(&self) -> Instant

Returns the current time.

impl Close for RealSystem

fn close(&self, fd: Fd) -> Result<()>

Closes a file descriptor.

impl Debug for RealSystem

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

Formats the value using the given formatter.

impl Dup for RealSystem

fn dup(&self, from: Fd, to_min: Fd, flags: EnumSet<FdFlag>) -> Result<Fd>

Duplicates a file descriptor.

fn dup2(&self, from: Fd, to: Fd) -> Result<Fd>

Duplicates a file descriptor.

impl Exec for RealSystem

fn execve( &self, path: &CStr, args: &[CString], envs: &[CString], ) -> impl Future<Output = Result<Infallible>> + use<>

Replaces the current process with an external utility.

impl Exit for RealSystem

fn exit( &self, exit_status: ExitStatus, ) -> impl Future<Output = Infallible> + use<>

Terminates the current process.

impl Fcntl for RealSystem

fn ofd_access(&self, fd: Fd) -> Result<OfdAccess>

Returns the open file description access mode.

fn get_and_set_nonblocking(&self, fd: Fd, nonblocking: bool) -> Result<bool>

Gets and sets the non-blocking mode for the open file description.

fn fcntl_getfd(&self, fd: Fd) -> Result<EnumSet<FdFlag>>

Returns the attributes for the file descriptor.

fn fcntl_setfd(&self, fd: Fd, flags: EnumSet<FdFlag>) -> Result<()>

Sets attributes for the file descriptor.

impl Fork for RealSystem

fn new_child_process(&self) -> Result<ChildProcessStarter<Self>>

Creates a new child process.

This implementation calls the fork system call and returns both in the parent and child process. In the parent, the returned ChildProcessStarter ignores any arguments and returns the child process ID. In the child, the starter runs the task and exits the process.

impl Fstat for RealSystem

fn fstat(&self, fd: Fd) -> Result<Stat>

Retrieves metadata of a file.

fn fstatat( &self, dir_fd: Fd, path: &CStr, follow_symlinks: bool, ) -> Result<Stat>

Retrieves metadata of a file.

fn is_directory(&self, path: &CStr) -> bool

Whether there is a directory at the specified path.

fn fd_is_pipe(&self, fd: Fd) -> bool

Tests if a file descriptor is a pipe.

impl GetCwd for RealSystem

fn getcwd(&self) -> Result<PathBuf>

Returns the current working directory path.

impl GetPid for RealSystem

fn getsid(&self, pid: Pid) -> Result<Pid>

Returns the session ID of the specified process.

fn getpid(&self) -> Pid

Returns the process ID of the current process.

fn getppid(&self) -> Pid

Returns the process ID of the parent process.

fn getpgrp(&self) -> Pid

Returns the process group ID of the current process.

impl GetPw for RealSystem

fn getpwnam_dir(&self, name: &CStr) -> Result<Option<PathBuf>>

Returns the home directory path of the given user.

impl GetRlimit for RealSystem

fn getrlimit(&self, resource: Resource) -> Result<LimitPair>

Returns the limits for the specified resource.

impl GetSigaction for RealSystem

fn get_sigaction(&self, signal: Number) -> Result<Disposition>

Gets the disposition for a signal.

impl GetUid for RealSystem

fn getuid(&self) -> Uid

Returns the real user ID of the current process.

fn geteuid(&self) -> Uid

Returns the effective user ID of the current process.

fn getgid(&self) -> Gid

Returns the real group ID of the current process.

fn getegid(&self) -> Gid

Returns the effective group ID of the current process.

impl IsExecutableFile for RealSystem

fn is_executable_file(&self, path: &CStr) -> bool

Whether there is an executable regular file at the specified path.

impl Isatty for RealSystem

fn isatty(&self, fd: Fd) -> bool

Tests if a file descriptor is associated with a terminal device.

impl Open for RealSystem

fn open( &self, path: &CStr, access: OfdAccess, flags: EnumSet<OpenFlag>, mode: Mode, ) -> Result<Fd>

Opens a file descriptor.

fn open_tmpfile(&self, parent_dir: &Path) -> Result<Fd>

Opens a file descriptor associated with an anonymous temporary file.

fn fdopendir(&self, fd: Fd) -> Result<impl Dir + use<>>

Opens a directory for enumerating entries.

fn opendir(&self, path: &CStr) -> Result<impl Dir + use<>>

Opens a directory for enumerating entries.

impl Pipe for RealSystem

fn pipe(&self) -> Result<(Fd, Fd)>

Creates an unnamed pipe.

impl Read for RealSystem

fn read(&self, fd: Fd, buffer: &mut [u8]) -> Result<usize>

Reads from the file descriptor.

impl Seek for RealSystem

fn lseek(&self, fd: Fd, position: SeekFrom) -> Result<u64>

Moves the position of the open file description.

impl Select for RealSystem

fn select( &self, readers: &mut Vec<Fd>, writers: &mut Vec<Fd>, timeout: Option<Duration>, signal_mask: Option<&[Number]>, ) -> Result<c_int>

Waits for a next event.

impl SendSignal for RealSystem

fn kill( &self, target: Pid, signal: Option<Number>, ) -> impl Future<Output = Result<()>> + use<>

Sends a signal.

fn raise(&self, signal: Number) -> impl Future<Output = Result<()>> + use<>

Sends a signal to the current process.

impl SetPgid for RealSystem

fn setpgid(&self, pid: Pid, pgid: Pid) -> Result<()>

Modifies the process group ID of a process.

impl SetRlimit for RealSystem

fn setrlimit(&self, resource: Resource, limits: LimitPair) -> Result<()>

Sets the limits for the specified resource.

impl ShellPath for RealSystem

fn shell_path(&self) -> CString

Returns the path to the shell.

On Linux, this function returns /proc/self/exe. On other platforms, it searches for an executable sh from the default PATH returned by confstr_path.

impl Sigaction for RealSystem

fn sigaction( &self, signal: Number, handling: Disposition, ) -> Result<Disposition>

Gets and sets the disposition for a signal.

impl Sigmask for RealSystem

fn sigmask( &self, op: Option<(SigmaskOp, &[Number])>, old_mask: Option<&mut Vec<Number>>, ) -> Result<()>

Gets and/or sets the signal blocking mask.

impl Signals for RealSystem

const SIGABRT: Number

The signal number for SIGABRT

const SIGALRM: Number

The signal number for SIGALRM

const SIGBUS: Number

The signal number for SIGBUS

const SIGCHLD: Number

The signal number for SIGCHLD

const SIGCLD: Option<Number> = None

The signal number for SIGCLD, if available on the system

const SIGCONT: Number

The signal number for SIGCONT

const SIGEMT: Option<Number> = None

The signal number for SIGEMT, if available on the system

const SIGFPE: Number

The signal number for SIGFPE

const SIGHUP: Number

The signal number for SIGHUP

const SIGILL: Number

The signal number for SIGILL

const SIGINFO: Option<Number> = None

The signal number for SIGINFO, if available on the system

const SIGINT: Number

The signal number for SIGINT

const SIGIO: Option<Number>

The signal number for SIGIO, if available on the system

const SIGIOT: Number

The signal number for SIGIOT

const SIGKILL: Number

The signal number for SIGKILL

const SIGLOST: Option<Number> = None

The signal number for SIGLOST, if available on the system

const SIGPIPE: Number

The signal number for SIGPIPE

const SIGPOLL: Option<Number>

The signal number for SIGPOLL, if available on the system

const SIGPROF: Number

The signal number for SIGPROF

const SIGPWR: Option<Number>

The signal number for SIGPWR, if available on the system

const SIGQUIT: Number

The signal number for SIGQUIT

const SIGSEGV: Number

The signal number for SIGSEGV

const SIGSTKFLT: Option<Number>

The signal number for SIGSTKFLT, if available on the system

const SIGSTOP: Number

The signal number for SIGSTOP

const SIGSYS: Number

The signal number for SIGSYS

const SIGTERM: Number

The signal number for SIGTERM

const SIGTHR: Option<Number> = None

The signal number for SIGTHR, if available on the system

const SIGTRAP: Number

The signal number for SIGTRAP

const SIGTSTP: Number

The signal number for SIGTSTP

const SIGTTIN: Number

The signal number for SIGTTIN

const SIGTTOU: Number

The signal number for SIGTTOU

const SIGURG: Number

The signal number for SIGURG

const SIGUSR1: Number

The signal number for SIGUSR1

const SIGUSR2: Number

The signal number for SIGUSR2

const SIGVTALRM: Number

The signal number for SIGVTALRM

const SIGWINCH: Number

The signal number for SIGWINCH

const SIGXCPU: Number

The signal number for SIGXCPU

const SIGXFSZ: Number

The signal number for SIGXFSZ

fn sigrt_range(&self) -> Option<RangeInclusive<Number>>

Returns the range of real-time signals supported by the system.

const NAMED_SIGNALS: &'static [(&'static str, Option<Number>)] = _

List of all signal names and their numbers, excluding real-time signals

fn iter_sigrt(&self) -> impl DoubleEndedIterator<Item = Number> + use<Self>

Returns an iterator over all real-time signals supported by the system.

fn to_signal_number<N: Into<RawNumber>>(&self, number: N) -> Option<Number>

Tests if a signal number is valid and returns its signal number.

fn sig2str<N: Into<RawNumber>>(&self, signal: N) -> Option<Cow<'static, str>>

Converts a signal number to its string representation.

fn str2sig(&self, name: &str) -> Option<Number>

Converts a string representation of a signal to its signal number.

fn validate_signal(&self, number: RawNumber) -> Option<(Name, Number)>

Tests if a signal number is valid and returns its name and number.

fn signal_name_from_number(&self, number: Number) -> Name

Returns the signal name for the signal number.

fn signal_number_from_name(&self, name: Name) -> Option<Number>

Gets the signal number from the signal name.

impl Sysconf for RealSystem

fn confstr_path(&self) -> Result<UnixString>

Returns the standard $PATH value where all standard utilities are expected to be found.

impl TcGetPgrp for RealSystem

fn tcgetpgrp(&self, fd: Fd) -> Result<Pid>

Returns the current foreground process group ID.

impl TcSetPgrp for RealSystem

fn tcsetpgrp( &self, fd: Fd, pgid: Pid, ) -> impl Future<Output = Result<()>> + use<>

Switches the foreground process group.

impl Times for RealSystem

fn times(&self) -> Result<CpuTimes>

Returns consumed CPU times.

This function actually uses getrusage rather than times because it provides better resolution on many systems.

impl Umask for RealSystem

fn umask(&self, new_mask: Mode) -> Mode

Gets and sets the file creation mode mask.

impl Wait for RealSystem

fn wait(&self, target: Pid) -> Result<Option<(Pid, ProcessState)>>

Reports updated status of a child process.

impl Write for RealSystem

fn write(&self, fd: Fd, buffer: &[u8]) -> Result<usize>

Writes to the file descriptor.