Struct sysinfo::CpuRefreshKind

pub struct CpuRefreshKind { /* private fields */ }

Used to determine what you want to refresh specifically on the Cpu type.

⚠️ Just like all other refresh types, ruling out a refresh doesn’t assure you that the information won’t be retrieved if the information is accessible without needing extra computation.

use sysinfo::{CpuExt, CpuRefreshKind, System, SystemExt};

let mut system = System::new();

// We don't want to update all the CPU information.
system.refresh_cpu_specifics(CpuRefreshKind::everything().without_frequency());

for cpu in system.cpus() {
    assert_eq!(cpu.frequency(), 0);
}

Implementations

impl CpuRefreshKind

pub fn new() -> Self

Creates a new CpuRefreshKind with every refresh set to false.

use sysinfo::CpuRefreshKind;

let r = CpuRefreshKind::new();

assert_eq!(r.frequency(), false);

Examples found in repository

src/traits.rs (line 705)

    fn refresh_cpu(&mut self) {
        self.refresh_cpu_specifics(CpuRefreshKind::new().with_cpu_usage())
    }

src/windows/cpu.rs (line 281)

    pub fn len(&mut self) -> usize {
        self.init_if_needed(CpuRefreshKind::new());
        self.cpus.len()
    }

pub fn everything() -> Self

Creates a new CpuRefreshKind with every refresh set to true.

use sysinfo::CpuRefreshKind;

let r = CpuRefreshKind::everything();

assert_eq!(r.frequency(), true);

Examples found in repository

src/common.rs (line 428)

    pub fn everything() -> Self {
        Self {
            networks: true,
            networks_list: true,
            processes: Some(ProcessRefreshKind::everything()),
            disks: true,
            disks_list: true,
            memory: true,
            cpu: Some(CpuRefreshKind::everything()),
            components: true,
            components_list: true,
            users_list: true,
        }
    }

pub fn cpu_usage(&self) -> bool

Returns the value of the “cpu_usage” refresh kind.

use sysinfo::CpuRefreshKind;

let r = CpuRefreshKind::new();
assert_eq!(r.cpu_usage(), false);

let r = r.with_cpu_usage();
assert_eq!(r.cpu_usage(), true);

let r = r.without_cpu_usage();
assert_eq!(r.cpu_usage(), false);

pub fn with_cpu_usage(self) -> Self

Sets the value of the “cpu_usage” refresh kind to true.

use sysinfo::CpuRefreshKind;

let r = CpuRefreshKind::new();
assert_eq!(r.cpu_usage(), false);

let r = r.with_cpu_usage();
assert_eq!(r.cpu_usage(), true);

Examples found in repository

src/traits.rs (line 705)

    fn refresh_cpu(&mut self) {
        self.refresh_cpu_specifics(CpuRefreshKind::new().with_cpu_usage())
    }

pub fn without_cpu_usage(self) -> Self

Sets the value of the “cpu_usage” refresh kind to false.

use sysinfo::CpuRefreshKind;

let r = CpuRefreshKind::everything();
assert_eq!(r.cpu_usage(), true);

let r = r.without_cpu_usage();
assert_eq!(r.cpu_usage(), false);

pub fn frequency(&self) -> bool

Returns the value of the “frequency” refresh kind.

use sysinfo::CpuRefreshKind;

let r = CpuRefreshKind::new();
assert_eq!(r.frequency(), false);

let r = r.with_frequency();
assert_eq!(r.frequency(), true);

let r = r.without_frequency();
assert_eq!(r.frequency(), false);

Examples found in repository

src/windows/cpu.rs (line 276)

    fn init_if_needed(&mut self, refresh_kind: CpuRefreshKind) {
        if self.cpus.is_empty() {
            let (cpus, vendor_id, brand) = super::tools::init_cpus(refresh_kind);
            self.cpus = cpus;
            self.global.vendor_id = vendor_id;
            self.global.brand = brand;
            self.got_cpu_frequency = refresh_kind.frequency();
        }
    }

src/windows/tools.rs (line 26)

pub(crate) fn init_cpus(refresh_kind: CpuRefreshKind) -> (Vec<Cpu>, String, String) {
    unsafe {
        let mut sys_info: SYSTEM_INFO = zeroed();
        GetSystemInfo(&mut sys_info);
        let (vendor_id, brand) = cpu::get_vendor_id_and_brand(&sys_info);
        let nb_cpus = sys_info.dwNumberOfProcessors as usize;
        let frequencies = if refresh_kind.frequency() {
            cpu::get_frequencies(nb_cpus)
        } else {
            vec![0; nb_cpus]
        };
        let mut ret = Vec::with_capacity(nb_cpus + 1);
        for (nb, frequency) in frequencies.iter().enumerate() {
            ret.push(Cpu::new_with_values(
                format!("CPU {}", nb + 1),
                vendor_id.clone(),
                brand.clone(),
                *frequency,
            ));
        }
        (ret, vendor_id, brand)
    }
}

src/windows/system.rs (line 167)

    fn refresh_cpu_specifics(&mut self, refresh_kind: CpuRefreshKind) {
        if self.query.is_none() {
            self.query = Query::new();
            if let Some(ref mut query) = self.query {
                add_english_counter(
                    r"\Processor(_Total)\% Processor Time".to_string(),
                    query,
                    get_key_used(self.cpus.global_cpu_mut()),
                    "tot_0".to_owned(),
                );
                for (pos, proc_) in self.cpus.iter_mut(refresh_kind).enumerate() {
                    add_english_counter(
                        format!(r"\Processor({pos})\% Processor Time"),
                        query,
                        get_key_used(proc_),
                        format!("{pos}_0"),
                    );
                }
            }
        }
        if let Some(ref mut query) = self.query {
            query.refresh();
            let mut used_time = None;
            if let Some(ref key_used) = *get_key_used(self.cpus.global_cpu_mut()) {
                used_time = Some(
                    query
                        .get(&key_used.unique_id)
                        .expect("global_key_idle disappeared"),
                );
            }
            if let Some(used_time) = used_time {
                self.cpus.global_cpu_mut().set_cpu_usage(used_time);
            }
            for p in self.cpus.iter_mut(refresh_kind) {
                let mut used_time = None;
                if let Some(ref key_used) = *get_key_used(p) {
                    used_time = Some(
                        query
                            .get(&key_used.unique_id)
                            .expect("key_used disappeared"),
                    );
                }
                if let Some(used_time) = used_time {
                    p.set_cpu_usage(used_time);
                }
            }
            if refresh_kind.frequency() {
                self.cpus.get_frequencies();
            }
        }
    }

pub fn with_frequency(self) -> Self

Sets the value of the “frequency” refresh kind to true.

use sysinfo::CpuRefreshKind;

let r = CpuRefreshKind::new();
assert_eq!(r.frequency(), false);

let r = r.with_frequency();
assert_eq!(r.frequency(), true);

pub fn without_frequency(self) -> Self

Sets the value of the “frequency” refresh kind to false.

use sysinfo::CpuRefreshKind;

let r = CpuRefreshKind::everything();
assert_eq!(r.frequency(), true);

let r = r.without_frequency();
assert_eq!(r.frequency(), false);

Trait Implementations

impl Clone for CpuRefreshKind

fn clone(&self) -> CpuRefreshKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CpuRefreshKind

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

Formats the value using the given formatter.

impl Default for CpuRefreshKind

fn default() -> CpuRefreshKind

Returns the “default value” for a type.

impl PartialEq<CpuRefreshKind> for CpuRefreshKind

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CpuRefreshKind

impl Eq for CpuRefreshKind

impl StructuralEq for CpuRefreshKind

impl StructuralPartialEq for CpuRefreshKind