Skip to main content

ProcessGroupStats

Struct ProcessGroupStats 

Source
#[non_exhaustive]
pub struct ProcessGroupStats { pub active_process_count: usize, pub total_cpu_time: Option<Duration>, pub peak_memory_bytes: Option<u64>, }
Available on crate feature stats only.
Expand description

A snapshot of a process group’s resource usage.

total_cpu_time and peak_memory_bytes are None when the platform can’t report them — notably the POSIX process-group mechanism (no cgroup accounting), i.e. macOS/BSD and the Linux fallback.

Non-exhaustive: a read-only snapshot the crate produces — new metrics can be added without a breaking change.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§active_process_count: usize

Number of live processes currently in the group.

Under the POSIX process-group mechanism (Mechanism::ProcessGroup — macOS/BSD and the Linux fallback) this counts live process groups rather than individual processes: a contained child that itself forks helpers still counts once. With a cgroup or Job Object it is the exact process count.

§total_cpu_time: Option<Duration>

Total CPU time (user + kernel) accumulated by the group, if available.

Semantic divergence by backend:

  • Windows Job Object — cumulative across all processes that have ever been part of the job, including already-terminated ones. Reflects the full historical cost of the tree.
  • Linux cgroup v2 — sum of /proc/<pid>/stat times for currently live members only; terminated processes are not accounted once they leave the cgroup.
  • POSIX process-group / macOS — always None; no kernel accumulator is available without a cgroup or Job Object.
§peak_memory_bytes: Option<u64>

Peak memory used by the group in bytes, if available. This is the OS’s own group-wide measure; its exact meaning differs by platform and it is not directly comparable across platforms, nor equal to the sum of the per-process RunningProcess::peak_memory_bytes (which is a resident-set peak):

  • Windows — the Job Object’s PeakJobMemoryUsed: peak committed memory (commit charge) charged to the job, not a working-set figure.
  • Linux cgroup v2 — the sum of currently-live members’ peak resident sets (VmHWM); members that already exited are not counted.
  • POSIX process-group / macOS — always None; no kernel accumulator.

Trait Implementations§

Source§

impl Clone for ProcessGroupStats

Source§

fn clone(&self) -> ProcessGroupStats

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ProcessGroupStats

Source§

impl Debug for ProcessGroupStats

Source§

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

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

impl Eq for ProcessGroupStats

Source§

impl PartialEq for ProcessGroupStats

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ProcessGroupStats

Auto Trait Implementations§

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> Any for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Source§

fn type_name(&self) -> &'static str

Source§

impl<T> AnySync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

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, dest: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more