Struct rustix::thread::Pid

source ·
#[repr(transparent)]
pub struct Pid(NonZeroI32);
Expand description

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§

source§

impl Pid

source

pub const INIT: Self = _

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

source

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.

source

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.

source

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

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

source

pub const fn as_raw_nonzero(self) -> NonZeroI32

Converts a Pid into a NonZeroI32.

source

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

Converts an Option<Pid> into a RawPid.

source

pub const fn is_init(self) -> bool

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

Trait Implementations§

source§

impl Clone for Pid

source§

fn clone(&self) -> Pid

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Pid

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn from(pid: Pid) -> Self

Converts to this type from the input type.
source§

impl Hash for Pid

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for Pid

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for Pid

source§

impl Eq for Pid

source§

impl StructuralPartialEq for Pid

Auto Trait Implementations§

§

impl Freeze for Pid

§

impl RefUnwindSafe for Pid

§

impl Send for Pid

§

impl Sync for Pid

§

impl Unpin for Pid

§

impl UnwindSafe for Pid

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.