Struct Environment

pub struct Environment { /* private fields */ }

An environment for fetching system utilisation

Implementations

impl Environment

pub fn load_average(&self) -> [f64; 3]

Returns the system load average value. This function returns three numbers, representing the last 1 minute, 5 minute, and 15 minute periods.

pub fn physical_cores(&self) -> usize

Fetches the estimate of the available parallelism of the hardware on which the database is running. This number often corresponds to the amount of CPUs, but it may diverge in various cases.

pub fn available_parallelism(&self) -> usize

Fetches the estimate of the available parallelism of the hardware on which the database is running. This number often corresponds to the amount of CPUs, but it may diverge in various cases.

pub fn cpu_usage(&self) -> f32

Returns the total CPU usage of the system as a percentage. This may be greater than 100% if running on a mult-core machine.

pub fn memory_usage(&self) -> u64

Returns the total memory usage (in bytes) of the system. This is the size of the memory allocated, not including swap.

pub fn refresh(&mut self)

Refreshes the current process information with memory and cpu usage details. This ensures that we only fetch data we need.

Trait Implementations

impl Default for Environment

fn default() -> Self

Returns the “default value” for a type.