windows-core 0.58.0

Rust for Windows
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

use super::*;
use core::marker::PhantomData;

/// A type representing an agile reference to a COM/WinRT object.
#[repr(transparent)]
#[derive(Clone, PartialEq, Eq)]
pub struct AgileReference<T>(imp::IAgileReference, PhantomData<T>);

impl<T: Interface> AgileReference<T> {
    /// Creates an agile reference to the object.
    pub fn new(object: &T) -> Result<Self> {
        // TODO: this assert is required until we can catch this at compile time using an "associated const equality" constraint.
        // For example, <T: Interface<UNKNOWN = true>>
        // https://github.com/rust-lang/rust/issues/92827
        assert!(T::UNKNOWN);
        unsafe {
            imp::RoGetAgileReference(
                imp::AGILEREFERENCE_DEFAULT,
                &T::IID,
                core::mem::transmute::<&T, &IUnknown>(object),
            )
            .map(|reference| Self(reference, Default::default()))
        }
    }

    /// Retrieves a proxy to the target of the `AgileReference` object that may safely be used within any thread context in which get is called.
    pub fn resolve(&self) -> Result<T> {
        unsafe { self.0.Resolve() }
    }
}

unsafe impl<T: Interface> Send for AgileReference<T> {}
unsafe impl<T: Interface> Sync for AgileReference<T> {}

impl<T> core::fmt::Debug for AgileReference<T> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "AgileReference({:?})", &self.0)
    }
}