Struct PidFd 

#[repr(transparent)]
pub struct PidFd {
    inner: InnerPidFd,
}

🔬This is a nightly-only experimental API. (linux_pidfd #82971)

Available on Linux only.

This type represents a file descriptor that refers to a process.

A PidFd can be obtained by setting the corresponding option on Command with create_pidfd. Subsequently, the created pidfd can be retrieved from the Child by calling pidfd or into_pidfd.

Example:

#![feature(linux_pidfd)]
use std::os::linux::process::{CommandExt, ChildExt};
use std::process::Command;

let mut child = Command::new("echo")
    .create_pidfd(true)
    .spawn()
    .expect("Failed to spawn child");

let pidfd = child
    .into_pidfd()
    .expect("Failed to retrieve pidfd");

// The file descriptor will be closed when `pidfd` is dropped.

Refer to the man page of pidfd_open(2) for further details.

Fields

inner: InnerPidFd

🔬This is a nightly-only experimental API. (linux_pidfd #82971)

Implementations

impl PidFd

pub fn kill(&self) -> Result<()>

🔬This is a nightly-only experimental API. (linux_pidfd #82971)

Forces the child process to exit.

Unlike Child::kill it is possible to attempt to kill reaped children since PidFd does not suffer from pid recycling races. But doing so will return an Error.

pub fn wait(&self) -> Result<ExitStatus>

🔬This is a nightly-only experimental API. (linux_pidfd #82971)

Waits for the child to exit completely, returning the status that it exited with.

Unlike Child::wait it does not ensure that the stdin handle is closed.

Additionally on kernels prior to 6.15 only the first attempt to reap a child will return an ExitStatus, further attempts will return an Error.

pub fn try_wait(&self) -> Result<Option<ExitStatus>>

🔬This is a nightly-only experimental API. (linux_pidfd #82971)

Attempts to collect the exit status of the child if it has already exited.

On kernels prior to 6.15, and unlike Child::try_wait, only the first attempt to reap a child will return an ExitStatus, further attempts will return an Error.

Trait Implementations

impl AsFd for PidFd

fn as_fd(&self) -> BorrowedFd<'_>

Available on Unix or HermitCore or target_os=trusty or WASI or target_os=motor only.

Borrows the file descriptor.

impl AsInner<InnerPidFd> for PidFd

fn as_inner(&self) -> &InnerPidFd

impl AsRawFd for PidFd

fn as_raw_fd(&self) -> RawFd

Available on Unix or HermitCore or target_os=trusty or WASI or target_os=motor only.

Extracts the raw file descriptor.

impl Debug for PidFd

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

Formats the value using the given formatter.

impl From<OwnedFd> for PidFd

fn from(fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<PidFd> for OwnedFd

fn from(pid_fd: PidFd) -> Self

Converts to this type from the input type.

impl FromInner<InnerPidFd> for PidFd

fn from_inner(inner: InnerPidFd) -> PidFd

impl FromRawFd for PidFd

unsafe fn from_raw_fd(fd: RawFd) -> Self

Available on Unix or HermitCore or target_os=trusty or WASI or target_os=motor only.

Constructs a new instance of Self from the given raw file descriptor.

impl IntoInner<InnerPidFd> for PidFd

fn into_inner(self) -> InnerPidFd

impl IntoRawFd for PidFd

fn into_raw_fd(self) -> RawFd

Available on Unix or HermitCore or target_os=trusty or WASI or target_os=motor only.

Consumes this object, returning the raw underlying file descriptor.