mcom 0.1.5

MaulingMonkey's COM wrappers
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

//! [MethodHResult]

use winapi::shared::winerror::{HRESULT, SUCCEEDED};

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



/// An error about some specific method returning an [HRESULT](https://www.hresult.info/)
#[derive(Clone)]
pub struct MethodHResult {
    pub(crate) method:  &'static str,
    pub(crate) hr:      HRESULT,
}

impl MethodHResult {
    /// Returns an `Err(MethodHResult(...))` if `!SUCCEEDED(hr)`
    pub fn check(method: &'static str, hr: HRESULT) -> Result<(), Self> {
        if SUCCEEDED(hr) {
            Ok(())
        } else {
            Err(Self::unchecked(method, hr))
        }
    }

    /// Returns the [HRESULT] of the error
    pub fn hresult(&self) -> HRESULT { self.hr }

    /// Returns a link in the format of e.g. "<https://www.hresult.info/Search?q=0x80000005>"
    #[deprecated = "This function will be removed in 0.2.0"]
    // #[cfg(feature = "alloc")] // XXX: this method predates the feature, so this feature gate cannot be introduced without a breaking change
    pub fn hresult_info_search_link(&self) -> alloc::string::String { alloc::format!("https://www.hresult.info/Search?q=0x{:08x}", self.to_u32()) }
}

impl MethodHResult {
    pub(crate) fn unchecked(method: &'static str, hr: HRESULT) -> Self { Self { method, hr } }
    pub(crate) fn to_u32(&self) -> u32 { self.hr as _ }
}

impl Debug   for MethodHResult { fn fmt(&self, fmt: &mut Formatter) -> fmt::Result { write!(fmt, "MethodHResult({:?}, 0x{:08x})", self.method, self.to_u32()) } }
impl Display for MethodHResult { fn fmt(&self, fmt: &mut Formatter) -> fmt::Result { write!(fmt, "{} failed with HRESULT == 0x{:08x}", self.method, self.to_u32()) } }

impl core::error::Error for MethodHResult {}

impl From<MethodHResult> for HRESULT { fn from(value: MethodHResult) -> Self { value.hresult() } }
#[cfg(feature = "winresult-types-0-1")] impl From<MethodHResult> for winresult_types_0_1::HResult { fn from(value: MethodHResult) -> Self { winresult_types_0_1::HResult::from(value.hr) } }