Skip to main content

SystemRss

Struct SystemRss 

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

Live reader of the current process’s swappable memory footprint.

The reading counts anonymous and private copy-on-write pages, shared-memory pages (tmpfs, memfd, POSIX shm) and, where the platform reports them, pages already swapped out or compressed. Clean file-backed pages — memory-mapped immutable files, executable text, page cache faulted in by reads — are excluded: the kernel drops and refaults them from their file, so they can never cause swap. Plain resident-set size counts them, which lets a process that only maps a large file look like it is exhausting memory.

PlatformMeasurement
Linux, AndroidRssAnon + RssShmem + VmSwap from /proc/self/status
macOS, iOSri_phys_footprint from proc_pid_rusage
Windowsprivate commit charge (PrivateUsage)
otherresident-set size

Every read is a handful of system calls on a buffer reused across reads, cheap enough for once-per-second sampling.

Implementations§

Source§

impl SystemRss

Source

pub fn new() -> Self

Construct a reader bound to the current process.

§Panics

Panics if the platform cannot identify the current process — a “cannot happen” condition.

Trait Implementations§

Source§

impl Default for SystemRss

Source§

fn default() -> Self

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

impl RssSource for SystemRss

Source§

fn read_rss_bytes(&self) -> u64

Current process memory in bytes.
Source§

fn total_ram_bytes(&self) -> u64

Installed system RAM in bytes. Used at startup when auto-deriving the budget target. Implementations must return a positive value.

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more