Struct ForegroundProcess 

#[non_exhaustive]
pub struct ForegroundProcess { /* private fields */ }

The process in the foreground of a terminal: the one that reads its keys, such as the shell at its prompt or the editor it started.

A local pty reads it from the process table: the terminal’s foreground process group (tcgetpgrp), then the name, arguments and working directory of that group’s leader, through proc_pidinfo and sysctl on macOS and /proc on Linux. Another ByteSource reports its own, or none.

Implementations

impl ForegroundProcess

pub fn new(pid: u32, name: impl Into<String>) -> Self

Process pid, named name, such as vim.

pub fn with_argv( self, argv: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Set the arguments, the program’s own name first.

pub fn with_cwd(self, cwd: impl Into<PathBuf>) -> Self

Set the working directory.

pub fn with_shell(self, shell: bool) -> Self

Set whether it is the program the terminal started, such as the shell at its prompt.

pub fn pid(&self) -> u32

The process id.

pub fn name(&self) -> &str

The executable’s name, such as vim.

pub fn argv(&self) -> &[String]

The arguments, the program’s own name first, when they could be read.

pub fn cwd(&self) -> Option<&Path>

The working directory, when it could be read.

pub fn is_shell(&self) -> bool

Whether it is the program the terminal started, such as the shell at its prompt, rather than a program that program runs. An application asks before it closes a terminal where this is false.

Trait Implementations

impl Clone for ForegroundProcess

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForegroundProcess

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

Formats the value using the given formatter.

impl Eq for ForegroundProcess

impl PartialEq for ForegroundProcess

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ForegroundProcess