shell::jobs

Struct Job

Source
pub struct Job { /* private fields */ }

Implementations§

Source§

impl Job

Source

pub fn is_empty(&self) -> bool

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

Source

pub fn pgid(&self) -> Pid

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

Source

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

Pids with status that make up a job.

Source

pub fn status(&self) -> JobStatus

Status of this job.

Source

pub fn mark_stopped(&mut self)

Mark the job as stopped.

Source

pub fn mark_running(&mut self)

Mark the job as running.

Source

pub fn mark_done(&mut self)

Mark the job status to done.

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn reverse(&mut self)

Reverse the list of pids in the job.

Source

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…).

Source

pub fn stealth(&self) -> bool

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

Source

pub fn interactive(&self) -> bool

Is this job running in an interactive shell?

Source

pub fn shell_pid(&self) -> Pid

The PID of the shell running this job.

Trait Implementations§

Source§

impl Clone for Job

Source§

fn clone(&self) -> Job

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Job

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Job

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Job

§

impl RefUnwindSafe for Job

§

impl Send for Job

§

impl Sync for Job

§

impl Unpin for Job

§

impl UnwindSafe for Job

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.