Lib.rs

Changelog | Source | Getting Started

Retrieve the current user and environment through simple functions.

Check out the documentation for examples.

Features

• Get the user's full name
• Get the user's username
• Get the user's preferred language(s)
• Get the devices's hostname
• Get the devices's "pretty" or "fancy" name
• Get the devices's desktop environment
• Get the devices's OS name and version
• Get the devices's platform name
• Get the devices's CPU architecture and its width

Supported Platforms

WhoAmI targets all platforms that can run Rust, including:

• Linux
• Windows
• Mac OS
• BSD variants (FreeBSD, others)
• illumos variants (SmartOS, OmniOS, others) Target-Specific MSRV 1.65
• Redox Target-Specific MSRV 1.65
• Web Assembly
  • Fake implementation
  • Web Browser - DOM
  • WASI (Wasite, others) untested, testing planned later
  • Daku (Ardaku/Quantii, others) planned later
• Android planned later
• iOS / watchOS / tvOS planned later
• Fuchsia planned later
• Others? (make a PR or open an issue)

MSRV

WhoAmI 1.x.y targets Rust 1.40.0 stable and later, and the 1.x.y track will be maintained at least until the release of the Rust 2024 edition.

The MSRV will not be updated until version 2.0.0, after which breaking changes may happen on minor releases, and version 2.0.0 will target Rust 1.65.0 and later to make use of the let else syntax. The current plan is for all 2.x releases to be supported and receive bugfixes at least until sometime in 2027, bumping MSRV only as needed.

Binary

whome: whoami command RiR (Re-written in Rust) that depends on this crate.

Testing

The testing procedure is documented at https://github.com/ardaku/whoami/blob/v1/TESTING.md. The full manual test suite is run for each change that affects multiple platforms.

License

Copyright © 2017-2024 The WhoAmI Contributors.

Licensed under any of

• Apache License, Version 2.0, (LICENSE_APACHE or https://www.apache.org/licenses/LICENSE-2.0)
• Boost Software License, Version 1.0, (LICENSE_BOOST or https://www.boost.org/LICENSE_1_0.txt)
• MIT License, (LICENSE_MIT or https://mit-license.org/)

at your option.

Contribution

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 licensed as described above, without any additional terms or conditions.

Help

If you want help using or contributing to this library, feel free to send me an email at aldaronlau@gmail.com.