pub struct ProcessRefreshKind { /* private fields */ }
Expand description

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

let mut system = System::new();

// We don't want to update the CPU information.
system.refresh_processes_specifics(ProcessRefreshKind::everything().without_cpu());

for (_, proc_) in system.processes() {
    // We use a `==` comparison on float only because we know it's set to 0 here.
    assert_eq!(proc_.cpu_usage(), 0.);
}

Implementations§

source§

impl ProcessRefreshKind

source

pub fn new() -> Self

Creates a new ProcessRefreshKind with every refresh set to false.

use sysinfo::ProcessRefreshKind;

let r = ProcessRefreshKind::new();

assert_eq!(r.cpu(), false);
assert_eq!(r.disk_usage(), false);
source

pub fn everything() -> Self

Creates a new ProcessRefreshKind with every refresh set to true.

use sysinfo::ProcessRefreshKind;

let r = ProcessRefreshKind::everything();

assert_eq!(r.cpu(), true);
assert_eq!(r.disk_usage(), true);
source

pub fn cpu(&self) -> bool

Returns the value of the “cpu” refresh kind.

use sysinfo::ProcessRefreshKind;

let r = ProcessRefreshKind::new();
assert_eq!(r.cpu(), false);

let r = r.with_cpu();
assert_eq!(r.cpu(), true);

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

pub fn with_cpu(self) -> Self

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

use sysinfo::ProcessRefreshKind;

let r = ProcessRefreshKind::new();
assert_eq!(r.cpu(), false);

let r = r.with_cpu();
assert_eq!(r.cpu(), true);
source

pub fn without_cpu(self) -> Self

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

use sysinfo::ProcessRefreshKind;

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

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

pub fn disk_usage(&self) -> bool

Returns the value of the “disk_usage” refresh kind.

use sysinfo::ProcessRefreshKind;

let r = ProcessRefreshKind::new();
assert_eq!(r.disk_usage(), false);

let r = r.with_disk_usage();
assert_eq!(r.disk_usage(), true);

let r = r.without_disk_usage();
assert_eq!(r.disk_usage(), false);
source

pub fn with_disk_usage(self) -> Self

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

use sysinfo::ProcessRefreshKind;

let r = ProcessRefreshKind::new();
assert_eq!(r.disk_usage(), false);

let r = r.with_disk_usage();
assert_eq!(r.disk_usage(), true);
source

pub fn without_disk_usage(self) -> Self

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

use sysinfo::ProcessRefreshKind;

let r = ProcessRefreshKind::everything();
assert_eq!(r.disk_usage(), true);

let r = r.without_disk_usage();
assert_eq!(r.disk_usage(), false);
source

pub fn user(&self) -> bool

Returns the value of the “user” refresh kind. This refresh is about user_id and group_id. Please note that it has an effect mostly on Windows as other platforms get this information alongside the Process information directly.

use sysinfo::ProcessRefreshKind;

let r = ProcessRefreshKind::new();
assert_eq!(r.user(), false);

let r = r.with_user();
assert_eq!(r.user(), true);

let r = r.without_user();
assert_eq!(r.user(), false);
source

pub fn with_user(self) -> Self

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

use sysinfo::ProcessRefreshKind;

let r = ProcessRefreshKind::new();
assert_eq!(r.user(), false);

let r = r.with_user();
assert_eq!(r.user(), true);
source

pub fn without_user(self) -> Self

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

use sysinfo::ProcessRefreshKind;

let r = ProcessRefreshKind::everything();
assert_eq!(r.user(), true);

let r = r.without_user();
assert_eq!(r.user(), false);

Trait Implementations§

source§

impl Clone for ProcessRefreshKind

source§

fn clone(&self) -> ProcessRefreshKind

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ProcessRefreshKind

source§

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

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

impl Default for ProcessRefreshKind

source§

fn default() -> ProcessRefreshKind

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

impl PartialEq<ProcessRefreshKind> for ProcessRefreshKind

source§

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

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

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.
source§

impl Copy for ProcessRefreshKind

source§

impl Eq for ProcessRefreshKind

source§

impl StructuralEq for ProcessRefreshKind

source§

impl StructuralPartialEq for ProcessRefreshKind

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.