retch-sysinfo 0.1.75

Cross-platform system and hardware information library (Linux, macOS, Windows) behind the retch fetcher
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

// SPDX-FileCopyrightText: 2026 Ken Tobias
// SPDX-License-Identifier: GPL-3.0-or-later

//! # retch-sysinfo
//!
//! System information gathering library for retch.
//!
//! Provides cross-platform hardware and OS detection, GPU identification,
//! battery status, and environment probing. Extracted from the `retch-cli`
//! binary to allow reuse as a standalone library.
//!
//! ## Modules
//!
//! - [`audio`] — Audio server and device detection.
//! - [`battery`] — Cross-platform battery status detection.
//! - [`bios`] — BIOS / firmware version detection.
//! - [`bluetooth`] — Bluetooth controller state and connected device detection.
//! - [`camera`] — Camera and webcam detection.
//! - [`display`] — Display detection and EDID parsing.
//! - [`gamepad`] — Gamepad and joystick controller detection.
//! - [`gpu`] — GPU detection and PCI ID lookup.
//! - [`gpu_api`] — Vulkan, OpenGL and OpenCL API version detection.
//! - [`input`] — Keyboard and pointing-device detection.
//! - [`io`] — Disk and network I/O throughput sampling.
//! - [`disk`] — Physical disk model, size, and type detection.
//! - [`media`] — Active media player and currently playing track detection.
//! - [`memory`] — Physical memory (RAM) slot detection.
//! - [`motherboard`] — Motherboard / system model detection.
//! - [`network`] — Network interface detection, IP resolution, and Wi-Fi.
//! - [`packages`] — Installed package count detection.
//! - [`shell`] — Shell detection and version querying.
//! - [`terminal`] — Terminal emulator detection and font configuration reading.
//! - [`theme`] — UI theme, icon, cursor, and font detection.
//! - [`weather`] — Weather information via Open-Meteo.
//! - [`wm`] — Window manager detection.
//! - [`fetch`] — Full system information gathering (`SystemInfo`, `CollectOptions`).

pub mod audio;
pub mod battery;
pub mod bios;
pub mod bluetooth;
pub mod btrfs;
pub mod camera;
pub mod disk;
pub mod display;
pub mod fetch;
pub mod gamepad;
pub mod gpu;
pub mod gpu_api;
pub mod input;
pub mod io;
pub mod media;
pub mod memory;
pub mod motherboard;
pub mod network;
pub mod packages;
pub mod shell;
pub mod terminal;
pub mod theme;
pub mod weather;
pub mod wm;
pub mod zfs;

// Gated on `test` as well as `windows` so the pure interface-classification rule (which
// decides whether a `GetIfTable2` row is a real adapter or an NDIS filter instance) is
// exercised by the Linux and macOS CI legs too — it is the load-bearing half, and it needs
// no Windows API to test.
#[cfg(any(target_os = "windows", test))]
pub(crate) mod win_iftable;
#[cfg(target_os = "windows")]
pub(crate) mod win_reg;
#[cfg(target_os = "windows")]
pub(crate) mod win_setupapi;
#[cfg(target_os = "windows")]
pub(crate) mod win_users;

#[cfg(target_os = "macos")]
pub(crate) mod macos_ffi;

pub use fetch::{CollectOptions, SystemInfo};

/// The crate README's code examples, compiled as doctests.
///
/// The README is the crates.io page, and its example had stopped compiling without anything
/// noticing — it borrowed `CollectOptions`, ignored the `Result`, and read plain `String`
/// fields as `Option`s. Including it here makes `cargo test --workspace` compile it.
#[doc = include_str!("../README.md")]
#[cfg(doctest)]
pub struct ReadmeDoctests;