gdt-cpus 0.2606.1

Game Developer's Toolkit for CPU Management
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

//! Error types and the `Result` alias used throughout the `gdt-cpus` crate.

use std::fmt;

/// A specialized `Result` type for `gdt-cpus` operations.
pub type Result<T> = std::result::Result<T, Error>;

/// The error enum for all operations within the `gdt-cpus` crate.
///
/// Payloads are descriptive strings; callers that need machine-readable
/// scheduler outcomes should use [`crate::AppliedPriority`] for priority calls.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Error {
    /// CPU information detection failed (parsing, unexpected system response,
    /// platform-specific trouble). Contains a descriptive message.
    Detection(String),

    /// An invalid logical-core ID was provided. Contains the offending ID.
    InvalidCoreId(usize),

    /// A thread affinity operation failed. Contains a descriptive message.
    Affinity(String),

    /// The requested operation is not supported on this OS or hardware.
    /// Contains a message explaining why.
    Unsupported(String),

    /// The operation requires permissions the process doesn't have (e.g.
    /// raising thread priority unprivileged). Contains the detail message.
    PermissionDenied(String),

    /// A system call failed (sysctl, Win32, raw syscalls). Contains a
    /// descriptive message.
    SystemCall(String),

    /// A requested resource was not found (file, registry key, sysctl key).
    /// Contains a message describing what was missing.
    NotFound(String),

    /// An invalid parameter was supplied. Contains the explanation.
    InvalidParameter(String),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::Detection(msg) => write!(f, "CPU detection error: {}", msg),
            Error::InvalidCoreId(id) => write!(f, "Invalid core ID: {}", id),
            Error::Affinity(msg) => write!(f, "Thread affinity error: {}", msg),
            Error::Unsupported(msg) => write!(f, "Unsupported operation: {}", msg),
            Error::PermissionDenied(msg) => write!(f, "Permission denied: {}", msg),
            Error::SystemCall(msg) => write!(f, "System call error: {}", msg),
            Error::NotFound(msg) => write!(f, "Not found: {}", msg),
            Error::InvalidParameter(msg) => write!(f, "Invalid parameter: {}", msg),
        }
    }
}

impl std::error::Error for Error {}