app-memory-usage-fetcher 0.3.0

Query a supported operating system to get the amount of memory used by the current Rust application.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

[![Build](https://github.com/rjzak/app-memory-usage-fetcher/actions/workflows/build.yml/badge.svg)](https://github.com/rjzak/app-memory-usage-fetcher/actions/workflows/build.yml)
[![Lint](https://github.com/rjzak/app-memory-usage-fetcher/actions/workflows/lint.yml/badge.svg)](https://github.com/rjzak/app-memory-usage-fetcher/actions/workflows/lint.yml)
[![Documentation](https://docs.rs/app-memory-usage-fetcher/badge.svg)](https://docs.rs/app-memory-usage-fetcher/)
[![Crates.io Version](https://img.shields.io/crates/v/app-memory-usage-fetcher)](https://crates.io/crates/app-memory-usage-fetcher)
[![Socket.dev](https://badge.socket.dev/cargo/package/app-memory-usage-fetcher/latest)](https://socket.dev/cargo/package/app-memory-usage-fetcher/overview/)

## Application Memory Usage Fetcher

A super simple crate which queries the supported operating system for the number of bytes used. For Unix-like systems, `rusage.ru_maxrss` is used. If your desired operating system isn't supported, please [file an issue](https://github.com/rjzak/app-memory-usage-fetcher/issues).
Additionally, there are helper functions which return the value as Kilo-/Mega-/Giga-/Tera- bytes where the values are based on 1024 bytes = 1 [kilobyte](https://en.wikipedia.org/wiki/Kilobyte).

This crate was created after trying to find this functionality from an existing crate, and instead I found [instances](https://www.reddit.com/r/rust/comments/b9irmd/question_how_to_determine_memory_usage_of_current/) [of](https://stackoverflow.com/questions/74558630/is-there-a-simple-way-to-measure-total-memory-consumption) [people](https://users.rust-lang.org/t/tracking-memory-usage/98451) [asking](https://www.reddit.com/r/rust/comments/twqi7e/how_to_investigate_memory_usage_of_your_rust/) for it. So I decided to make it. This can be helpful, such as trying to see if code changes result in less memory usage, for example.

Operating Systems:
* Testing: Linux, macOS, FreeBSD, Windows
* Untested: AIX, Android, DragonFly BSD, NetBSD, OpenBSD
* Unsupported: Haiku, Solaris, Wasi

Unsupported operating systems fail gracefully with a reported usage of `None` and a compiler warning.