Struct rustix::pid::Pid

#[repr(transparent)]
pub struct Pid(NonZeroI32);

pid_t—A non-zero Unix process ID.

This is a pid, and not a pidfd. It is not a file descriptor, and the process it refers to could disappear at any time and be replaced by another, unrelated, process.

Tuple Fields

0: NonZeroI32

Implementations

impl Pid

pub const INIT: Self = _

A Pid corresponding to the init process (pid 1).

pub const fn from_raw(raw: RawPid) -> Option<Self>

Converts a RawPid into a Pid.

Returns Some for positive RawPids. Otherwise, returns None.

This is safe because a Pid is a number without any guarantees for the kernel. Non-child Pids are always racy for any syscalls, but can only cause logic errors. If you want race-free access to or control of non-child processes, please consider other mechanisms like pidfd on Linux.

pub const unsafe fn from_raw_unchecked(raw: RawPid) -> Self

Converts a known positive RawPid into a Pid.

Safety

The caller must guarantee raw is positive.

pub fn from_child(child: &Child) -> Self

Creates a Pid holding the ID of the given child process.

pub const fn as_raw_nonzero(self) -> NonZeroI32

Converts a Pid into a NonZeroI32.

pub fn as_raw(pid: Option<Self>) -> RawPid

Converts an Option<Pid> into a RawPid.

pub const fn is_init(self) -> bool

Test whether this pid represents the init process (pid 1).

Trait Implementations

impl Clone for Pid

fn clone(&self) -> Pid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pid

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

Formats the value using the given formatter.

impl<'a, Num: ArgNumber> From<Pid> for ArgReg<'a, Num>

fn from(pid: Pid) -> Self

Converts to this type from the input type.

impl Hash for Pid

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Pid

fn eq(&self, other: &Pid) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Pid

impl Eq for Pid

impl StructuralPartialEq for Pid