Skip to main content

Memory

Struct Memory 

Source
#[non_exhaustive]
pub struct Memory { pub total: Bytes, pub used: Bytes, pub free: Bytes, pub host_total: Bytes, pub host_free: Bytes, pub unused: Option<Bytes>, pub cached: Option<Bytes>, pub limit: Option<MemoryLimit>, pub swap: Swap, pub source: MemorySource, }
Expand description

Every memory value from one set of reads; see snapshot.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§total: Bytes

What this process may use: the host’s memory, or the container’s limit when that is smaller.

§used: Bytes

In use, counted against total.

§free: Bytes

Available to new allocations without swapping (reclaimable cache counts as available). used + free == total always holds.

§host_total: Bytes

The machine’s memory, ignoring any limit.

§host_free: Bytes

Available on the machine, ignoring any limit.

§unused: Option<Bytes>

Pages doing nothing at all (the kernel’s MemFree), when reported.

§cached: Option<Bytes>

File cache that can be reclaimed, when reported. Windows: None, as the only documented source counts every handle on the machine; its available memory already includes the standby cache.

§limit: Option<MemoryLimit>

The limit applied to total, when there is one.

§swap: Swap

Swap space (all zero when there is none).

§source: MemorySource

Where total and used came from.

Implementations§

Source§

impl Memory

Source

pub fn used_percent(&self) -> Percent

used as a share of total.

Source

pub fn free_percent(&self) -> Percent

free as a share of total.

Trait Implementations§

Source§

impl Clone for Memory

Source§

fn clone(&self) -> Self

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

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Memory

Source§

impl Debug for Memory

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Forget for Memory

§

impl Freeze for Memory

§

impl Move for Memory

§

impl RefUnwindSafe for Memory

§

impl Send for Memory

§

impl Sync for Memory

§

impl Unpin for Memory

§

impl UnsafeUnpin for Memory

§

impl UnwindSafe for Memory

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

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

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.