Module rustix::process

Available on crate feature process only.

Process-associated operations.

Structs

• CpuSet
  CpuSet represents a bit-mask of CPUs.
• Gid
  gid_t—A Unix group ID.
• KillResult
  Reaper status as returned by get_reaper_status.
• Pid
  pid_t—A non-zero Unix process ID.
• PidInfo
  A child process of a reaper.
• PidInfoFlags
  REAPER_PIDINFO_*.
• ReaperStatus
  Reaper status as returned by get_reaper_status.
• ReaperStatusFlags
  REAPER_STATUS_*.
• Rlimit
  struct rlimit—Current and maximum values used in getrlimit, setrlimit, and [prlimit].
• Uid
  uid_t—A Unix user ID.
• WaitOptions
  Options for modifying the behavior of wait/waitpid.
• WaitStatus
  The status of a child process after calling wait/waitpid.
• WaitidOptions
  Options for modifying the behavior of waitid.
• WaitidStatus
  The status of a process after calling waitid.

Enums

• DumpableBehavior
  PROC_TRACE_CTL_*.
• IdType
  Subset of idtype_t C enum, with only the values allowed by procctl.
• Resource
  A resource value for use with getrlimit, setrlimit, and prlimit.
• Signal
  A signal number for use with kill_process, kill_process_group, and kill_current_process_group.
• TracingStatus
  Tracing status as returned by trace_status.
• TrapCapBehavior
  PROC_TRAPCAP_CTL_*.
• WaitId
  The identifier to wait on in a call to waitid.

Constants

• EXIT_FAILURE
  EXIT_FAILURE for use with exit.
• EXIT_SIGNALED_SIGABRT
  The exit status used by a process terminated with a Signal::Abort signal.
• EXIT_SUCCESS
  EXIT_SUCCESS for use with exit.

Functions

• chdirfs
  chdir(path)—Change the current working directory.
• chrootfs
  chroot(path)—Change the process root directory.
• fchdir
  fchdir(fd)—Change the current working directory.
• get_reaper_pids
  Get the list of descendants of the specified reaper process.
• get_reaper_status
  Get information about the reaper of the specified process (or the process itself if it is a reaper).
• getcwdfs
  getCWD—Return the current working directory.
• getegid
  getegid()—Returns the process’ effective group ID.
• geteuid
  geteuid()—Returns the process’ effective user ID.
• getgid
  getgid()—Returns the process’ real group ID.
• getgroups
  getgroups()—Return a list of the current user’s groups.
• getpgid
  getpgid(pid)—Returns the process group ID of the given process.
• getpgrp
  getpgrp()—Returns the process’ group ID.
• getpid
  getpid()—Returns the process’ ID.
• getppid
  getppid()—Returns the parent process’ ID.
• getpriority_pgrp
  getpriority(PRIO_PGRP, gid)—Get the scheduling priority of the given process group.
• getpriority_process
  getpriority(PRIO_PROCESS, pid)—Get the scheduling priority of the given process.
• getpriority_user
  getpriority(PRIO_USER, uid)—Get the scheduling priority of the given user.
• getrlimit
  getrlimit(resource)—Get a process resource limit value.
• getsid
  getsid(pid)—Get the session ID of the given process.
• getuid
  getuid()—Returns the process’ real user ID.
• ioctl_tiocsctty
  ioctl(fd, TIOCSCTTY, 0)—Sets the controlling terminal for the process.
• kill_current_process_group
  kill(0, sig)—Sends a signal to all processes in the current process group.
• kill_process
  kill(pid, sig)—Sends a signal to a process.
• kill_process_group
  kill(-pid, sig)—Sends a signal to all processes in a process group.
• nice
  nice(inc)—Adjust the scheduling priority of the current process.
• no_new_privs
  Check the no_new_privs mode of the specified process.
• parent_process_death_signal
  Get the current value of the parent process death signal.
• reaper_kill
  Deliver a signal to some subset of
• sched_getaffinity
  sched_getaffinity(pid)—Get a thread’s CPU affinity mask.
• sched_setaffinity
  sched_setaffinity(pid, cpuset)—Set a thread’s CPU affinity mask.
• sched_yield
  sched_yield()—Hints to the OS that other processes should run.
• set_dumpable_behavior
  Set the state of the dumpable attribute for the process indicated by idtype and id. This determines whether the process can be traced and whether core dumps are produced for the process upon delivery of a signal whose default behavior is to produce a core dump.
• set_no_new_privs
  Enable the no_new_privs mode that ignores SUID and SGID bits on execve in the specified process and its future descendants.
• set_parent_process_death_signal
  Set the parent-death signal of the calling process.
• set_reaper_status
  Acquire or release the reaper status of the calling process.
• set_trap_cap_behavior
  Set the current value of the capability mode violation trapping behavior. If this behavior is enabled, the kernel would deliver a Signal::Trap signal on any return from a system call that would result in a io::Errno::NOTCAPABLE or [io::Errno::CAPMODE`] error.
• setpgid
  setpgid(pid, pgid)—Sets the process group ID of the given process.
• setpriority_pgrp
  setpriority(PRIO_PGRP, pgid)—Get the scheduling priority of the given process group.
• setpriority_process
  setpriority(PRIO_PROCESS, pid)—Get the scheduling priority of the given process.
• setpriority_user
  setpriority(PRIO_USER, uid)—Get the scheduling priority of the given user.
• setrlimit
  setrlimit(resource, new)—Set a process resource limit value.
• setsid
  setsid()—Create a new session.
• test_kill_current_process_group
  kill(0, 0)—Check validity of pid and permissions to send signals to the all processes in the current process group, without actually sending any signals.
• test_kill_process
  kill(pid, 0)—Check validity of pid and permissions to send signals to the process, without actually sending any signals.
• test_kill_process_group
  kill(-pid, 0)—Check validity of pid and permissions to send signals to all processes in the process group, without actually sending any signals.
• trace_status
  Get the tracing status of the process indicated by idtype and id.
• trap_cap_behavior
  Get the current value of the capability mode violation trapping behavior.
• umaskfs
  umask(mask)—Set the process file creation mask.
• wait
  wait(waitopts)—Wait for any of the children of calling process to change state.
• waitid
  waitid(_, _, _, opts)—Wait for the specified child process to change state.
• waitpgid
  waitpid(-pgid, waitopts)—Wait for a process in a specific process group to change state.
• waitpid
  waitpid(pid, waitopts)—Wait for a specific process to change state.

Type Aliases

• ProcSelector
  A process selector for use with the procctl interface.
• RawGid
  The raw integer value of a Unix group ID. A group identifier as a raw integer.
• RawPid
  The raw integer value of a Unix process ID. A process identifier as a raw integer.
• RawUid
  The raw integer value of a Unix user ID. A user identifier as a raw integer.