[][src]Crate heim

heim is a fast and eventually fully-featured async library for the Rust programming language intended to provide any possible information about the system it is running on.

At a high level, it provides information about:

  • CPU
  • Disks
  • Host
  • Memory
  • Networks (in progress)
  • Processes (in progress)
  • Virtualization (in progress)
  • Windows services (in progress)
  • Hardware sensors (in progress)

Platform support

At the moment, heim is in MVP phase, which means that there is only only partial support for Tier 1 platforms (Linux, macOS, and Windows for i686 and x86_64). You can check the GitHub projects page for more information.

In addition, it would be good to double check if the returned information is correct. You know, just in case.

Documentation

Note that heim also provides platform-specific APIs. If you are browsing this documentation via docs.rs, do not forget to use the platform selector at the page header.

Also, due to Rust bug #15823, type aliases are not rendered properly across the sub-crates bounds, therefore documentation might look terrible in some places, consider checking the sources or sub-crates documentation in such case.

Modules

cpu

CPU information.

disk

Disks information.

host

Host system information.

memory

Memory and swap information.

net

Network information.

process

System processes information.

sensors

Sensors information.

units

Measurement units used in API.

virt

Virtualization system detection.

Enums

Error

Any error which may happen during the data fetch.

Type Definitions

Result

Type alias for types returned by heim functions.