Struct heim::process::Process

pub struct Process(_);

OS process.

Methods

impl Process

pub fn pid(&self) -> i32

Returns the process pid.

pub fn parent_pid(&self) -> impl Future<Output = Result<i32, ProcessError>>

Returns future which resolves into the process parent pid.

pub fn parent(&self) -> impl Future<Output = Result<Process, ProcessError>>

Returns future which resolves into the parent Process.

pub fn name(&self) -> impl Future<Output = Result<String, ProcessError>>

Returns future which resolves into the process name.

pub fn exe(&self) -> impl Future<Output = Result<PathBuf, ProcessError>>

Returns future which resolves into the process executable as an absolute path.

pub fn cwd(&self) -> impl Future<Output = Result<PathBuf, ProcessError>>

Returns future which resolves into the process current working directory.

Compatibility

For Windows this method is not implemented yet and will always return an error, see #105.

pub fn status(&self) -> impl Future<Output = Result<Status, ProcessError>>

Returns future which resolves into the current process status.

pub fn cpu_time(&self) -> impl Future<Output = Result<CpuTime, ProcessError>>

Returns future which resolves into the accumulated process time.

pub fn cpu_usage(&self) -> impl Future<Output = Result<CpuUsage, ProcessError>>

Returns future which resolves into the CPU usage measurement.

Returned CpuUsage struct represents instantaneous CPU usage and does not represent any reasonable value by itself. It is suggested to wait for a while with help of any async timer (for accuracy recommended delay should be at least 100 ms), call this method once again and subtract former CpuUsage from the new one.

Same to any *nix system, calculated CPU usage might exceed 100 % if the process is running multiple threads on different CPU cores.

Example

let process = process::current().await?;
let measurement_1 = process.cpu_usage().await?;
// Or any other async timer at your choice
futures_timer::Delay::new(Duration::from_millis(100)).await?;
let measurement_2 = process.cpu_usage().await?;

println!("CPU usage: {} %", (measurement_2 - measurement_1).get::<ratio::percent>());

pub fn memory(&self) -> impl Future<Output = Result<Memory, ProcessError>>

Returns future which resolves into the memory information about this process.

Trait Implementations

impl ProcessExt for Process

fn io_counters(
    &self
) -> Pin<Box<dyn Future<Output = Result<IoCounters, ProcessError>> + Send>>

Returns future which resolves into process IO counters.

fn net_io_counters(
    &self
) -> Pin<Box<dyn Stream<Item = Result<IoCounters, ProcessError>> + Send>>

Returns stream which yield this process [IO counters] for each network interface.

impl Debug for Process

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

Formats the value using the given formatter.