Struct Job

pub struct Job {
    id: u32,
    shell_pid: Pid,
    pgid: Pid,
    pids: Vec<PidStatus>,
    names: Vec<String>,
    status: JobStatus,
    interactive: bool,
    stealth: bool,
}

Fields

id: u32

shell_pid: Pid

pgid: Pid

pids: Vec<PidStatus>

names: Vec<String>

status: JobStatus

interactive: bool

stealth: bool

Implementations

impl Job

fn new(id: u32, shell_pid: Pid, interactive: bool) -> Self

Create a new empty job with id.

pub fn is_empty(&self) -> bool

True if this job is empty (contains no processes).

pub fn pgid(&self) -> Pid

The process group id for the job. Should be equal to the first pid.

pub fn pids(&self) -> &[PidStatus]

Pids with status that make up a job.

pub fn status(&self) -> JobStatus

Status of this job.

pub fn mark_stopped(&mut self)

Mark the job as stopped.

pub fn mark_running(&mut self)

Mark the job as running.

pub fn mark_done(&mut self)

Mark the job status to done.

pub fn add_process(&mut self, pid: Pid, name: impl Into<String>)

Add pid to list of pids as Running with name. If the pid list is currently empty record this pid as the pgid (process group) for the job.

pub fn process_done(&mut self, pid: Pid, status: i32)

Move the process pid to the done state with status. Will panic if pid is not part of job.

pub fn process_error(&mut self, pid: Pid)

Move the process pid to the error state. Will panic if pid is not part of job.

pub fn process_signaled(&mut self, pid: Pid, signal: OsSignal)

Move the process pid to the signaled state. Will panic if pid is not part of job.

pub fn reverse(&mut self)

Reverse the list of pids in the job.

pub fn set_stealth(&mut self, stealth: bool)

Set the stealth flag, if true then do NOT print out when a background job ends (be stealthy…).

pub fn stealth(&self) -> bool

Is this a stealth job (do not report when complete if in the background)?

pub fn interactive(&self) -> bool

Is this job running in an interactive shell?

pub fn shell_pid(&self) -> Pid

The PID of the shell running this job.

Trait Implementations

impl Clone for Job

fn clone(&self) -> Job

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Job

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

Formats the value using the given formatter.

impl Display for Job

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

Formats the value using the given formatter.