Struct Job 

pub struct Job {
    pub id: usize,
    pub command_line: String,
    pub state: JobState,
    /* private fields */
}

Encapsulates a set of processes managed by the shell as a single unit.

Fields

id: usize

The shell-internal ID of the job.

command_line: String

The command line of the job.

state: JobState

The current operational state of the job.

Implementations

impl Job

pub fn to_pid_style_string(&self) -> String

Returns a pid-style string for the job.

pub fn annotation(&self) -> JobAnnotation

Returns the annotation of the job.

pub fn command_name(&self) -> &str

Returns the command name of the job.

pub const fn is_current(&self) -> bool

Returns whether the job is the current job.

pub const fn is_prev(&self) -> bool

Returns whether the job is the previous job.

pub fn poll_done( &mut self, ) -> Result<Option<Result<ExecutionResult, Error>>, Error>

Polls whether the job has completed.

pub async fn wait(&mut self) -> Result<ExecutionResult, Error>

Waits for the job to complete.

pub fn move_to_background(&mut self) -> Result<(), Error>

Moves the job to execute in the background.

pub fn move_to_foreground(&mut self) -> Result<(), Error>

Moves the job to execute in the foreground.

pub fn kill(&self, signal: TrapSignal) -> Result<(), Error>

Kills the job.

Arguments

• signal - The signal to send to the job.

pub fn representative_pid(&self) -> Option<i32>

Tries to retrieve a “representative” pid for the job.

pub fn process_group_id(&self) -> Option<i32>

Tries to retrieve the process group ID (PGID) of the job.

Trait Implementations

impl Display for Job

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

Formats the value using the given formatter.