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 39495/week @ 2024-08-04 33914/week @ 2024-08-11 40944/week @ 2024-08-18 36654/week @ 2024-08-25 36924/week @ 2024-09-01 38986/week @ 2024-09-08 33073/week @ 2024-09-15 30886/week @ 2024-09-22 38981/week @ 2024-09-29 36035/week @ 2024-10-06 35152/week @ 2024-10-13 38487/week @ 2024-10-20 35461/week @ 2024-10-27 40392/week @ 2024-11-03 35117/week @ 2024-11-10 34837/week @ 2024-11-17

147,969 downloads per month
Used in 88 crates (31 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–8MB
~62K SLoC