Skip to main content

RefreshKind

Struct RefreshKind 

Source
pub struct RefreshKind { /* private fields */ }
Expand description

Used to determine what you want to refresh specifically on the System 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::{RefreshKind, System};

// We want everything except memory.
let mut system = System::new_with_specifics(RefreshKind::everything().without_memory());

assert_eq!(system.total_memory(), 0);
assert!(system.processes().len() > 0);

Implementations§

Source§

impl RefreshKind

Source

pub fn nothing() -> Self

Creates a new RefreshKind with every refresh set to false/None.

use sysinfo::RefreshKind;

let r = RefreshKind::nothing();

assert_eq!(r.processes().is_some(), false);
assert_eq!(r.memory().is_some(), false);
assert_eq!(r.cpu().is_some(), false);
Source

pub fn everything() -> Self

Creates a new RefreshKind with every refresh set to true/Some(...).

use sysinfo::RefreshKind;

let r = RefreshKind::everything();

assert_eq!(r.processes().is_some(), true);
assert_eq!(r.memory().is_some(), true);
assert_eq!(r.cpu().is_some(), true);
Source

pub fn processes(&self) -> Option<ProcessRefreshKind>

Returns the value of the “processes” refresh kind.

use sysinfo::{RefreshKind, ProcessRefreshKind};

let r = RefreshKind::nothing();
assert_eq!(r.processes().is_some(), false);

let r = r.with_processes(ProcessRefreshKind::everything());
assert_eq!(r.processes().is_some(), true);

let r = r.without_processes();
assert_eq!(r.processes().is_some(), false);
Source

pub fn with_processes(self, kind: ProcessRefreshKind) -> Self

Sets the value of the “processes” refresh kind to Some(...).

use sysinfo::{RefreshKind, ProcessRefreshKind};

let r = RefreshKind::nothing();
assert_eq!(r.processes().is_some(), false);

let r = r.with_processes(ProcessRefreshKind::everything());
assert_eq!(r.processes().is_some(), true);
Source

pub fn without_processes(self) -> Self

Sets the value of the “processes” refresh kind to None.

use sysinfo::RefreshKind;

let r = RefreshKind::everything();
assert_eq!(r.processes().is_some(), true);

let r = r.without_processes();
assert_eq!(r.processes().is_some(), false);
Source

pub fn memory(&self) -> Option<MemoryRefreshKind>

Returns the value of the “memory” refresh kind.

use sysinfo::{RefreshKind, MemoryRefreshKind};

let r = RefreshKind::nothing();
assert_eq!(r.memory().is_some(), false);

let r = r.with_memory(MemoryRefreshKind::everything());
assert_eq!(r.memory().is_some(), true);

let r = r.without_memory();
assert_eq!(r.memory().is_some(), false);
Source

pub fn with_memory(self, kind: MemoryRefreshKind) -> Self

Sets the value of the “memory” refresh kind to Some(...).

use sysinfo::{RefreshKind, MemoryRefreshKind};

let r = RefreshKind::nothing();
assert_eq!(r.memory().is_some(), false);

let r = r.with_memory(MemoryRefreshKind::everything());
assert_eq!(r.memory().is_some(), true);
Source

pub fn without_memory(self) -> Self

Sets the value of the “memory” refresh kind to None.

use sysinfo::RefreshKind;

let r = RefreshKind::everything();
assert_eq!(r.memory().is_some(), true);

let r = r.without_memory();
assert_eq!(r.memory().is_some(), false);
Source

pub fn cpu(&self) -> Option<CpuRefreshKind>

Returns the value of the “cpu” refresh kind.

use sysinfo::{RefreshKind, CpuRefreshKind};

let r = RefreshKind::nothing();
assert_eq!(r.cpu().is_some(), false);

let r = r.with_cpu(CpuRefreshKind::everything());
assert_eq!(r.cpu().is_some(), true);

let r = r.without_cpu();
assert_eq!(r.cpu().is_some(), false);
Source

pub fn with_cpu(self, kind: CpuRefreshKind) -> Self

Sets the value of the “cpu” refresh kind to Some(...).

use sysinfo::{RefreshKind, CpuRefreshKind};

let r = RefreshKind::nothing();
assert_eq!(r.cpu().is_some(), false);

let r = r.with_cpu(CpuRefreshKind::everything());
assert_eq!(r.cpu().is_some(), true);
Source

pub fn without_cpu(self) -> Self

Sets the value of the “cpu” refresh kind to None.

use sysinfo::RefreshKind;

let r = RefreshKind::everything();
assert_eq!(r.cpu().is_some(), true);

let r = r.without_cpu();
assert_eq!(r.cpu().is_some(), false);

Trait Implementations§

Source§

impl Clone for RefreshKind

Source§

fn clone(&self) -> RefreshKind

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

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RefreshKind

Source§

impl Debug for RefreshKind

Source§

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

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

impl Default for RefreshKind

Source§

fn default() -> RefreshKind

Returns the “default value” for a type. Read more
Source§

impl Eq for RefreshKind

Source§

impl PartialEq for RefreshKind

Source§

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

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

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 RefreshKind

Auto Trait Implementations§

§

impl Freeze for RefreshKind

§

impl RefUnwindSafe for RefreshKind

§

impl Send for RefreshKind

§

impl Sync for RefreshKind

§

impl Unpin for RefreshKind

§

impl UnsafeUnpin for RefreshKind

§

impl UnwindSafe for RefreshKind

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

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
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.