hypomnesis 0.1.0

External RAM and VRAM measurement for Rust processes (process RSS plus per-process and device-wide GPU memory: Windows DXGI + NVML, Linux NVML, with nvidia-smi fallback).
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

// SPDX-License-Identifier: MIT OR Apache-2.0

//! Error types for `hypomnesis`.

/// Errors that can occur during a `hypomnesis` measurement.
///
/// `#[non_exhaustive]`: new variants will be added as new backends are introduced
/// (e.g., AMD `ROCm` SMI, Apple Metal). Patch-release-safe.
#[non_exhaustive]
#[derive(Debug, thiserror::Error)]
pub enum HypomnesisError {
    /// Process `RSS` query failed (platform API error).
    #[error("RAM query failed: {0}")]
    Ram(String),

    /// `NVML` query failed (library load, symbol lookup, FFI call,
    /// or driver-reported error code).
    #[error("NVML error: {0}")]
    Nvml(String),

    /// `DXGI` query failed (factory creation, adapter enumeration,
    /// `IDXGIAdapter3` cast, or interface call).
    #[error("DXGI error: {0}")]
    Dxgi(String),

    /// `nvidia-smi` subprocess invocation failed or produced unparseable output.
    #[error("nvidia-smi error: {0}")]
    NvidiaSmi(String),

    /// Requested device index is past the number of available GPUs.
    #[error("device index {index} out of range (have {count} devices)")]
    DeviceIndexOutOfRange {
        /// The requested zero-based index.
        index: u32,
        /// The number of available devices.
        count: u32,
    },

    /// No GPU measurement source was usable.
    ///
    /// Returned when `NVML`, `DXGI`, and `nvidia-smi` all failed (or were
    /// disabled by feature flags) for a single query.
    #[error(
        "no GPU measurement source available (NVML, DXGI, and nvidia-smi all failed or are disabled)"
    )]
    NoGpuSource,

    /// I/O error (e.g., reading `/proc/self/status` on Linux).
    #[error(transparent)]
    Io(#[from] std::io::Error),
}

/// Result alias for `hypomnesis` operations.
pub type Result<T> = std::result::Result<T, HypomnesisError>;