Enum TokenPrivilegeError 

#[non_exhaustive]
pub enum TokenPrivilegeError {
    OpenTokenFailed(Error),
    QueryFailed(Error),
    InvalidPrivilegeName {
        name: String,
    },
    LookupFailed {
        name: String,
        source: Error,
    },
    CheckFailed(Error),
    UnsupportedPlatform,
}

Errors that can occur when querying token privileges.

This enum is #[non_exhaustive] to allow adding new error variants in future minor releases without breaking downstream code. Always include a wildcard arm when matching.

Examples

use token_privilege::TokenPrivilegeError;

fn handle_error(err: TokenPrivilegeError) {
    match err {
        TokenPrivilegeError::UnsupportedPlatform => {
            eprintln!("This feature requires Windows");
        }
        other => eprintln!("Token error: {other}"),
    }
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

OpenTokenFailed(Error)

Failed to open the process token.

This typically occurs if the process lacks sufficient permissions to query its own token (very rare in practice).

QueryFailed(Error)

Failed to query token information.

Returned when GetTokenInformation fails after the token has been successfully opened.

InvalidPrivilegeName

The specified privilege name is invalid or not recognized.

The Windows privilege name (e.g., "SeDebugPrivilege") was not found in the system’s privilege database.

Fields

name: String

The privilege name that was not recognized.

LookupFailed

Failed to look up the privilege value for the given name.

Unlike InvalidPrivilegeName, this indicates an OS-level failure during the lookup rather than an unknown privilege name.

Fields

name: String

The privilege name that was being looked up.

source: Error

The underlying OS error.

CheckFailed(Error)

Failed to check privilege status.

Returned when PrivilegeCheck fails after the privilege LUID has been successfully resolved.

UnsupportedPlatform

This functionality is only available on Windows.

All public functions in this crate return this error on non-Windows platforms. This allows downstream crates to depend on token-privilege unconditionally and handle the non-Windows case gracefully.

Trait Implementations

impl Debug for TokenPrivilegeError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for TokenPrivilegeError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for TokenPrivilegeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.