3 stable releases

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

#15 in Profiling

Download history 36523/week @ 2025-01-28 45999/week @ 2025-02-04 47817/week @ 2025-02-11 62876/week @ 2025-02-18 51589/week @ 2025-02-25 58711/week @ 2025-03-04 65824/week @ 2025-03-11 68503/week @ 2025-03-18 68209/week @ 2025-03-25 71079/week @ 2025-04-01 69088/week @ 2025-04-08 62894/week @ 2025-04-15 62078/week @ 2025-04-22 62543/week @ 2025-04-29 68882/week @ 2025-05-06 55403/week @ 2025-05-13

255,639 downloads per month
Used in 119 crates (43 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–8.5MB
~69K SLoC