winresult-types 0.1.3

windows result types
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

use bytemuck::*;
use core::convert::Infallible;



/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-erref/87fba13e-bf06-450e-83b1-9241dc81e781)\]
/// NTSTATUS
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default, Pod, Zeroable)] #[repr(transparent)] pub struct NtStatus(pub(crate) u32);

impl NtStatus {
    #[doc(hidden)] pub const fn from_constant(value: u32) -> Self { Self(value) }

    pub const fn sev                (self) -> NtStatusSeverity { NtStatusSeverity((self.0 >> 30) as _) }

    pub const fn is_error           (self) -> bool { self.sev().0 == 3 }
    pub const fn is_warning         (self) -> bool { self.sev().0 == 2 }
    pub const fn is_informational   (self) -> bool { self.sev().0 == 1 }
    pub const fn is_success         (self) -> bool { self.sev().0 == 0 }

    pub const fn is_customer        (self) -> bool { self.0 & 0x20000000 != 0 }
    pub const fn is_ntstatus        (self) -> bool { self.0 & 0x10000000 != 0 }

    pub const fn facility           (self) -> u16  { (self.0 & 0x0FFF0000 >> 16) as _ }
    pub const fn code               (self) -> u16  { self.0 as _ }
    pub const fn to_u32             (self) -> u32  { self.0 }
}

impl From<NtStatus> for u32 { fn from(hr: NtStatus) -> Self { hr.0 } }
impl From<u32> for NtStatus { fn from(hr: u32) -> Self { Self(hr) } }
impl From<Infallible> for NtStatus { fn from(i: Infallible) -> Self { match i {} } }



/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-erref/87fba13e-bf06-450e-83b1-9241dc81e781)\]
/// NtStatus::Sev
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] pub struct NtStatusSeverity(pub(crate) u8);

impl NtStatusSeverity {
    #[doc(hidden)] pub const fn from_constant(value: u8) -> Self { assert!(value < 4, "NTSTATUS severities are only 2 bits"); Self(value) }

    pub const fn to_u8 (self) ->  u8 { self.0 }
    pub const fn to_u16(self) -> u16 { self.0 as _ }
    pub const fn to_u32(self) -> u32 { self.0 as _ }
}



/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-erref/87fba13e-bf06-450e-83b1-9241dc81e781)\]
/// FACILITY_\* values corresponding to Microsoft (non-customer) `NTSTATUS`es.
///
/// Note that HRESULT facilities, despite also being prefixed with FACILITY_\*, are incompatible (overlapping values interpreted differently!)
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] pub struct NtStatusFacilityMicrosoft(pub(crate) u16);

impl NtStatusFacilityMicrosoft {
    #[doc(hidden)] pub const fn from_constant(value: u16) -> Self { assert!(value <= 0xFFF, "NTSTATUS facilities are only 12 bits"); Self(value) }

    pub const fn to_u16(self) -> u16 { self.0 }
    pub const fn to_u32(self) -> u32 { self.0 as _ }
}

impl From<NtStatusFacilityMicrosoft> for u16 { fn from(f: NtStatusFacilityMicrosoft) -> Self { f.0 } }
impl From<NtStatusFacilityMicrosoft> for u32 { fn from(f: NtStatusFacilityMicrosoft) -> Self { f.0.into() } }