Struct PidFd 

pub struct PidFd { /* private fields */ }

A file descriptor that refers to a process.

This type represents a Linux pidfd (process file descriptor), which is a file descriptor that refers to a process. Unlike traditional PIDs, pidfds cannot be reused, making them safe from PID reuse race conditions.

On nightly Rust with the nightly feature, this re-exports std::os::linux::process::PidFd. On stable Rust, this provides a compatible implementation.

Implementations

impl PidFd

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

Sends SIGKILL to the process referred to by the pidfd.

This is a convenience method equivalent to send_signal(libc::SIGKILL).

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

Waits for the process referred to by the pidfd to exit and returns its exit status.

This method blocks until the process exits. Use try_wait for a non-blocking alternative, or AsyncPidFd::wait for async code.

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

Checks if the process referred to by the pidfd has exited without blocking.

Returns Ok(Some(status)) if the process has exited, Ok(None) if it’s still running.

Trait Implementations

impl AsFd for PidFd

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

Borrows the file descriptor.

impl AsRawFd for PidFd

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

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 FromRawFd for PidFd

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoRawFd for PidFd

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl PidFdExt for PidFd

fn from_self() -> Result<PidFd>

Creates a PidFd for the current process.

fn from_pid(pid: i32) -> Result<PidFd>

Creates a PidFd from a process ID. Calling this is highly discouraged as it is racy and the resulting pidfd might not refer to the expected process.

fn get_pid(&self) -> Result<i32>

Gets the process ID of the process referred to by the pidfd.

fn get_ppid(&self) -> Result<i32>

Gets the process ID of the parent process referred to by the pidfd.

fn get_id(&self) -> Result<u64>

Gets a unique identifier of the process referred to by the pidfd.

fn get_creds(&self) -> Result<PidFdCreds>

Gets the credentials (UIDs and GIDs) of the process referred to by the pidfd.

fn get_cgroupid(&self) -> Result<u64>

Gets the cgroup ID of the process.

fn get_namespace(&self, ns: &PidFdGetNamespace) -> Result<OwnedFd>

Gets a file descriptor to a namespace of type ns of the process referred to by the pidfd.

fn access_proc<R, F: FnOnce() -> R>(&self, func: F) -> Result<R>

Executes a function with protection against PID reuse.

fn send_signal(&self, signal: i32) -> Result<()>

Sends a signal (e.g., libc::SIGTERM) to the process referred to by the pidfd.

fn set_namespace(&self, ns: CloneFlags) -> Result<()>

Moves the calling process into the namespaces of the process referred to by the pidfd.

fn get_remote_fd(&self, target_fd: i32) -> Result<OwnedFd>

Installs a duplicate of a file descriptor from the process referred to by the pidfd in the current process.

impl TryFrom<PidFd> for AsyncPidFd

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pifd: PidFd) -> Result<Self, Error>

Performs the conversion.