3 stable releases

1.2.0 Jun 26, 2024
1.1.0 Dec 26, 2022
1.0.0 Mar 20, 2022

#13 in Profiling

Download history 82930/week @ 2025-06-03 99898/week @ 2025-06-10 86378/week @ 2025-06-17 131425/week @ 2025-06-24 91299/week @ 2025-07-01 112597/week @ 2025-07-08 116743/week @ 2025-07-15 104230/week @ 2025-07-22 112166/week @ 2025-07-29 143399/week @ 2025-08-05 128127/week @ 2025-08-12 132290/week @ 2025-08-19 124805/week @ 2025-08-26 126579/week @ 2025-09-02 140945/week @ 2025-09-09 131614/week @ 2025-09-16

547,521 downloads per month
Used in 151 crates (51 directly)

MIT/Apache

16KB
210 lines

Memory Stats

Crates.io License Build Status Dragon Powered

A cross-platform memory profiler for Rust, supporting Windows, Linux, and MacOS. This crate provides two metrics:

  • "Physical" Memory, which corresponds to the Resident Set Size on Linux and MacOS and the Working Set on Windows.
  • "Virtual" Memory, which corresponds to the Virtual Size on Linux and MacOS and the Pagefile Usage on Windows.

Usage

Add memory-stats as a dependency to your Cargo.toml:

[dependencies]
memory-stats = "1.2.0"

Optional Features

serde: Enables serialization and deserialization of the MemoryStats struct.

Example

Here's an example that prints out the current memory usage:

use memory_stats::memory_stats;

fn main() {
    if let Some(usage) = memory_stats() {
        println!("Current physical memory usage: {}", usage.physical_mem);
        println!("Current virtual memory usage: {}", usage.virtual_mem);
    } else {
        println!("Couldn't get the current memory usage :(");
    }
}

Caveats

Getting accurate memory usage on Linux is fairly expensive and not always possible. This crate always attempts to use the statistics from /proc/self/smaps if avaliable. However, since support for /proc/self/smaps might not be compiled in on all kernels, this crate will also use the faster but less accurate statistics from /proc/self/statm as a fallback.

If speed is needed over accuracy, the always_use_statm feature can be enabled to always use the /proc/self/statm statistics.

License

This crate is dual-licensed under either:

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~0–10MB
~85K SLoC