Struct sysinfo::System

pub struct System { /* private fields */ }

Structs containing system’s information.

Trait Implementations

impl Debug for System

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

Formats the value using the given formatter.

impl Default for System

fn default() -> System

Returns the “default value” for a type.

impl SystemExt for System

const IS_SUPPORTED: bool = true

Returns true if this OS is supported. Please refer to the crate-level documentation to get the list of supported OSes.

const SUPPORTED_SIGNALS: &'static [Signal] = _

Returns the list of the supported signals on this system (used by ProcessExt::kill_with).

fn new_with_specifics(refreshes: RefreshKind) -> System

Creates a new System instance and refresh the data corresponding to the given RefreshKind.

fn refresh_memory(&mut self)

Refreshes RAM and SWAP usage.

fn refresh_components_list(&mut self)

Refreshes components list.

fn refresh_cpu_specifics(&mut self, refresh_kind: CpuRefreshKind)

Refreshes CPUs specific information.

fn refresh_processes_specifics(&mut self, refresh_kind: ProcessRefreshKind)

Gets all processes and updates the specified information.

fn refresh_process_specifics(
    &mut self,
    pid: Pid,
    refresh_kind: ProcessRefreshKind
) -> bool

Refreshes only the process corresponding to pid. Returns false if the process doesn’t exist (it will NOT be removed from the processes if it doesn’t exist anymore). If it isn’t listed yet, it’ll be added.

fn refresh_disks_list(&mut self)

The disk list will be emptied then completely recomputed.

fn refresh_users_list(&mut self)

Refreshes users list.

fn processes(&self) -> &HashMap<Pid, Process>

Returns the process list.

fn process(&self, pid: Pid) -> Option<&Process>

Returns the process corresponding to the given pid or None if no such process exists.

fn global_cpu_info(&self) -> &Cpu

Returns “global” cpus information (aka the addition of all the CPUs).

fn cpus(&self) -> &[Cpu]

Returns the list of the CPUs.

fn physical_core_count(&self) -> Option<usize>

Returns the number of physical cores on the CPU or None if it couldn’t get it.

fn networks(&self) -> &Networks

Returns the network interfaces object.

fn networks_mut(&mut self) -> &mut Networks

Returns a mutable access to network interfaces.

fn total_memory(&self) -> u64

Returns the RAM size in bytes.

fn free_memory(&self) -> u64

Returns the amount of free RAM in bytes.

fn available_memory(&self) -> u64

Returns the amount of available RAM in bytes.

fn used_memory(&self) -> u64

Returns the amount of used RAM in bytes.

fn total_swap(&self) -> u64

Returns the SWAP size in bytes.

fn free_swap(&self) -> u64

Returns the amount of free SWAP in bytes.

fn used_swap(&self) -> u64

Returns the amount of used SWAP in bytes.

fn components(&self) -> &[Component]

Returns the components list.

fn components_mut(&mut self) -> &mut [Component]

Returns a mutable components list.

fn disks(&self) -> &[Disk]

Returns the disks list.

fn disks_mut(&mut self) -> &mut [Disk]

Returns the disks list.

fn sort_disks_by<F>(&mut self, compare: F)where
    F: FnMut(&Disk, &Disk) -> Ordering,

Sort the disk list with the provided callback.

fn uptime(&self) -> u64

Returns system uptime (in seconds).

fn load_average(&self) -> LoadAvg

Returns the system load average value.

fn users(&self) -> &[User]

Returns the users list.

fn boot_time(&self) -> u64

Returns the time (in seconds) when the system booted since UNIX epoch.

fn name(&self) -> Option<String>

Returns the system name.

fn long_os_version(&self) -> Option<String>

Returns the system long os version (e.g “MacOS 11.2 BigSur”).

fn host_name(&self) -> Option<String>

Returns the system hostname based off DNS

fn kernel_version(&self) -> Option<String>

Returns the system’s kernel version.

fn os_version(&self) -> Option<String>

Returns the system version (e.g. for MacOS this will return 11.1 rather than the kernel version).

fn distribution_id(&self) -> String

Returns the distribution id as defined by os-release, or std::env::consts::OS.

fn new() -> Self

Creates a new System instance with nothing loaded except the cpus list. If you want to load components, network interfaces or the disks, you’ll have to use the refresh_*_list methods. SystemExt::refresh_networks_list for example.

fn new_all() -> Self

Creates a new System instance with everything loaded.

fn refresh_specifics(&mut self, refreshes: RefreshKind)

Refreshes according to the given RefreshKind. It calls the corresponding “refresh_” methods.

fn refresh_all(&mut self)

Refreshes all system, processes, disks and network interfaces information.

fn refresh_system(&mut self)

Refreshes system information (RAM, swap, CPU usage and components’ temperature).

fn refresh_cpu(&mut self)

Refreshes CPUs information.

fn refresh_components(&mut self)

Refreshes components’ temperature.

fn refresh_processes(&mut self)

Gets all processes and updates their information.

fn refresh_process(&mut self, pid: Pid) -> bool

Refreshes only the process corresponding to pid. Returns false if the process doesn’t exist (it will NOT be removed from the processes if it doesn’t exist anymore). If it isn’t listed yet, it’ll be added.

fn refresh_disks(&mut self)

Refreshes the listed disks’ information.

fn refresh_networks(&mut self)

Refreshes networks data.

fn refresh_networks_list(&mut self)

The network list will be updated: removing not existing anymore interfaces and adding new ones.

fn processes_by_name<'a>(
    &'a self,
    name: &'a str
) -> Box<dyn Iterator<Item = &'a Process> + 'a>

Returns an iterator of process containing the given name.

fn processes_by_exact_name<'a>(
    &'a self,
    name: &'a str
) -> Box<dyn Iterator<Item = &'a Process> + 'a>

Returns an iterator of processes with exactly the given name.

fn get_user_by_id(&self, user_id: &Uid) -> Option<&User>

Returns the User matching the given user_id.