Struct com::ComRc

pub struct ComRc<T: ComInterface + ?Sized> { /* fields omitted */ }

A reference counted COM interface.

This smart pointer type automatically calls AddRef when cloned and Release when dropped.

This is normally the correct way to interact with an interface. If for some (usually unsafe) reason, you need to interact with an interface without automatically performing AddRef and Release, you can use the ComPtr type.

Methods

impl ComRc<dyn IClassFactory>

pub fn get_instance<T: ComInterface + ?Sized>(&self) -> Option<ComRc<T>>

Get an instance of the associated Co Class

impl<T: ComInterface + ?Sized> ComRc<T>

pub fn new(ptr: ComPtr<T>) -> ComRc<T>

Creates a new ComRc that comforms to the interface T.

pub unsafe fn from_raw(ptr: *mut *mut <T as ComInterface>::VTable) -> Self

Construct an ComRc from a raw pointer to a COM interface.

Safety

The same safety guarantees as ComPtr::new must be upheld by the function.

pub fn as_raw(&self) -> *mut *mut <T as ComInterface>::VTable

Gets the underlying interface ptr. This ptr is only guarnteed to live for as long as the current ComRc is alive.

pub fn get_interface<I: ComInterface + ?Sized>(&self) -> Option<ComRc<I>>

A safe version of QueryInterface. If the backing CoClass implements the interface I then a Some containing an ComRc pointing to that interface will be returned otherwise None will be returned.

Trait Implementations

impl<T: ComInterface + ?Sized> Clone for ComRc<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: ComInterface + ?Sized> Drop for ComRc<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ComInterface + ?Sized> From<ComRc<T>> for ComPtr<T>

fn from(rc: ComRc<T>) -> Self

Convert from an ComRc to an ComPtr

Note that this does not call the release on the underlying interface which gurantees that the ComPtr will still point to a valid interface. If Release is never called on this pointer, than memory may be leaked.

impl<T: IClassFactory + ComInterface + ?Sized> IClassFactory for ComRc<T>

unsafe fn create_instance(
    &self,
    aggr: *mut IUnknownVPtr,
    riid: *const GUID,
    ppv: *mut *mut c_void
) -> HRESULT

the CreateInstance COM method

unsafe fn lock_server(&self, increment: BOOL) -> HRESULT

the LockServer COM method

impl<T: IUnknown + ComInterface + ?Sized> IUnknown for ComRc<T>

unsafe fn query_interface(
    &self,
    riid: *const GUID,
    ppv: *mut *mut c_void
) -> HRESULT

The COM [QueryInterface Method]

unsafe fn add_ref(&self) -> u32

The COM [AddRef Method]

unsafe fn release(&self) -> u32

The COM [Release Method]