firehazard 0.0.0-2022-09-10

//! Error handling types and functions

use winapi::shared::ntstatus::*;
use winapi::shared::winerror::*;
use winapi::um::errhandlingapi::GetLastError;

use core::fmt::{self, Debug, Formatter};



pub(crate) trait ResultErrorExt<R>             { fn unerr(self, err: u32, remap: R) -> Self; }
impl<R> ResultErrorExt<R> for Result<R, Error> { fn unerr(self, err: u32, remap: R) -> Self { match self { Err(e) if e == err => Ok(remap), r => r } } }

/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/errhandlingapi/nf-errhandlingapi-getlasterror)\] DWORD/[u32], typically from GetLastError, representing an error code, hresult, or ntstatus
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)]
pub struct Error(pub(crate) u32);

impl Error {
    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/errhandlingapi/nf-errhandlingapi-getlasterror)\] GetLastError
    pub fn get_last() -> Self { Self(unsafe { GetLastError() }) }

    /// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/errhandlingapi/nf-errhandlingapi-getlasterror)\] GetLastError if `error`
    pub fn get_last_if(error: bool) -> Result<(), Self> { if !error { Ok(()) } else { Err(Self::get_last()) } }

    pub fn friendly(self) -> &'static str {
        match self.0 {
            NO_ERROR                        => "NO_ERROR",                      // 0
            ERROR_FILE_NOT_FOUND            => "ERROR_FILE_NOT_FOUND",          // 2
            ERROR_ACCESS_DENIED             => "ERROR_ACCESS_DENIED",           // 5
            ERROR_INVALID_HANDLE            => "ERROR_INVALID_HANDLE",          // 6
            ERROR_BAD_ENVIRONMENT           => "ERROR_BAD_ENVIRONMENT",         // 10
            ERROR_BAD_LENGTH                => "ERROR_BAD_LENGTH",              // 24
            ERROR_NOT_SUPPORTED             => "ERROR_NOT_SUPPORTED",           // 50
            ERROR_INVALID_PARAMETER         => "ERROR_INVALID_PARAMETER",       // 87
            ERROR_EXCL_SEM_ALREADY_OWNED    => "ERROR_EXCL_SEM_ALREADY_OWNED",  // 101
            ERROR_INSUFFICIENT_BUFFER       => "ERROR_INSUFFICIENT_BUFFER",     // 122
            ERROR_BAD_ARGUMENTS             => "ERROR_BAD_ARGUMENTS",           // 160
            ERROR_BAD_PATHNAME              => "ERROR_BAD_PATHNAME",            // 161
            ERROR_BUSY                      => "ERROR_BUSY",                    // 170
            ERROR_PARTIAL_COPY              => "ERROR_PARTIAL_COPY",            // 299
            ERROR_NO_TOKEN                  => "ERROR_NO_TOKEN",                // 1008
            ERROR_PRIVILEGE_NOT_HELD        => "ERROR_PRIVILEGE_NOT_HELD",      // 1314
            ERROR_INVALID_SUB_AUTHORITY     => "ERROR_INVALID_SUB_AUTHORITY",   // 1335
            ERROR_INVALID_ACL               => "ERROR_INVALID_ACL",             // 1336
            ERROR_INVALID_SID               => "ERROR_INVALID_SID",             // 1337
            ERROR_INVALID_SECURITY_DESCR    => "ERROR_INVALID_SECURITY_DESCR",  // 1338
            ERROR_BAD_INHERITANCE_ACL       => "ERROR_BAD_INHERITANCE_ACL",     // 1340
            ERROR_INVALID_ID_AUTHORITY      => "ERROR_INVALID_ID_AUTHORITY",    // 1343
            ERROR_ALLOTTED_SPACE_EXCEEDED   => "ERROR_ALLOTTED_SPACE_EXCEEDED", // 1344
            ERROR_BAD_TOKEN_TYPE            => "ERROR_BAD_TOKEN_TYPE",          // 1349
            ERROR_INCORRECT_SIZE            => "ERROR_INCORRECT_SIZE",          // 1462
            ERROR_DYNAMIC_CODE_BLOCKED      => "ERROR_DYNAMIC_CODE_BLOCKED",    // 1655
            1657                            => "ERROR_STRICT_CFG_VIOLATION",    // 1657
            ERROR_INVALID_ENVIRONMENT       => "ERROR_INVALID_ENVIRONMENT",     // 1805 - prefer ERROR_BAD_ENVIRONMENT ?
            _                               => match self.0 as _ {
                E_STRING_NOT_NULL_TERMINATED    => "E_STRING_NOT_NULL_TERMINATED",      // 0x80000017
                STATUS_INVALID_HANDLE           => "STATUS_INVALID_HANDLE",             // 0xC0000008
                STATUS_ACCESS_DENIED            => "STATUS_ACCESS_DENIED",              // 0xC0000022
                STATUS_BAD_IMPERSONATION_LEVEL  => "STATUS_BAD_IMPERSONATION_LEVEL",    // 0xC00000A5
                STATUS_DLL_NOT_FOUND            => "STATUS_DLL_NOT_FOUND",              // 0xC0000135
                STATUS_DLL_INIT_FAILED          => "STATUS_DLL_INIT_FAILED",            // 0xC0000142
                _ if self.0 & 0xF000_0000 == 0x8000_0000    => "E_???",                 // 0x8???????
                _ if self.0 & 0xF000_0000 == 0xC000_0000    => "STATUS_???",            // 0xC???????
                _                                           => "ERROR_???",             // 0x????????
            },
        }
    }
}

impl Debug for Error {
    fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
        if self.0 < 0x8000_0000 {
            write!(fmt, "Error({} {})", self.0, self.friendly())
        } else {
            write!(fmt, "Error(0x{:X} {})", self.0, self.friendly())
        }
    }
}

impl From<Error> for i32 { fn from(err: Error) -> Self { err.0 as _ } }
impl From<Error> for u32 { fn from(err: Error) -> Self { err.0 as _ } }
impl From<Error> for crate::io::Error { fn from(err: Error) -> Self { Self::from_raw_os_error(err.into()) } }
impl From<i32> for Error { fn from(err: i32      ) -> Self { Self(err as _) } }
impl From<u32> for Error { fn from(err: u32      ) -> Self { Self(err as _) } }
impl PartialEq<i32> for Error { fn eq(&self, other: &i32) -> bool { *self == Error::from(*other) } }
impl PartialEq<u32> for Error { fn eq(&self, other: &u32) -> bool { *self == Error::from(*other) } }
impl PartialEq<Error> for i32 { fn eq(&self, other: &Error) -> bool { Error::from(*self) == *other } }
impl PartialEq<Error> for u32 { fn eq(&self, other: &Error) -> bool { Error::from(*self) == *other } }