Struct intercom::ComItf

pub struct ComItf<T> where
    T: ?Sized,  { /* private fields */ }

An incoming COM interface pointer.

Intercom will implement the various [com_interface] traits for the corresponding ComItf<T> type.

This applies only to the pure interfaces. Implicit interfaces created through #[com_interface] impl MyStruct constructs are not supported for ComItf<T>.

Implementations

impl<T: ?Sized> ComItf<T>

pub fn new(
    automation: InterfacePtr<AutomationTypeSystem, T>,
    raw: InterfacePtr<RawTypeSystem, T>
) -> ComItf<T>

Creates a ComItf<T> from a raw type system COM interface pointer..

pub fn maybe_new(
    automation: Option<InterfacePtr<AutomationTypeSystem, T>>,
    raw: Option<InterfacePtr<RawTypeSystem, T>>
) -> Option<ComItf<T>>

Creates a ComItf<T> from a raw type system COM interface pointer..

pub unsafe fn wrap<TS: TypeSystem>(ptr: InterfacePtr<TS, T>) -> ComItf<T>

Creates a ComItf<T> from a raw type system COM interface pointer..

Safety

The ComItf must not outlast the reference owned by the provided pointer.

pub fn ptr<TS: TypeSystem>(this: &Self) -> Option<InterfacePtr<TS, T>>

Gets the raw COM pointer from the ComItf<T>.

pub fn as_raw_iunknown(&self) -> &ComItf<dyn RawIUnknown>

pub fn as_iunknown(&self) -> &ComItf<dyn IUnknown>

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

pub fn query_interface<TTarget: ComInterface + ?Sized>(
    this: &Self
) -> ComResult<ComRc<TTarget>>

Query interface on the ComItf.

pub fn as_rc(this: &Self) -> ComRc<T>

Trait Implementations

impl<T: ComInterface + ?Sized> AsRef<ComItf<T>> for ComRc<T>

fn as_ref(&self) -> &ComItf<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: ComInterface + ?Sized> Borrow<ComItf<T>> for ComRc<T>

fn borrow(&self) -> &ComItf<T>

Immutably borrows from an owned value.

impl<T: ?Sized> Debug for ComItf<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: ComInterface + ?Sized> Deref for ComItf<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, TS: TypeSystem, I: ComInterface + ?Sized> ExternInput<TS> for &'a ComItf<I> where
    I: ForeignType, 

type Lease = ()

unsafe fn into_foreign_parameter(
    self
) -> ComResult<(Self::ForeignType, Self::Lease)>

Safety

type Owned = ComItf<I>

unsafe fn from_foreign_parameter(
    source: Self::ForeignType
) -> ComResult<Self::Owned>

Safety

impl<'a, TS: TypeSystem, I: ComInterface + ?Sized> ExternType<TS> for &'a ComItf<I> where
    I: ForeignType, 

type ForeignType = Option<InterfacePtr<TS, I>>

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

fn from(source: &ComItf<T>) -> Self

Converts to this type from the input type.

impl<T: ComInterface + ?Sized> From<&ComItf<T>> for Variant

fn from(src: &ComItf<T>) -> Self

Converts to this type from the input type.

impl<I: ComInterface + IAllocator + ?Sized> IAllocator for ComItf<I>

unsafe fn alloc(&self, len: usize) -> *mut c_void

Allocates a segment of memory that is safe to pass through intercom interfaces.

unsafe fn alloc_bstr(&self, text: *const u16, len: u32) -> BSTR

Allocates a new BSTR based on an existing string value.

unsafe fn free(&self, ptr: *mut c_void)

Frees a segment of memory received through intercom interfaces.

unsafe fn free_bstr(&self, bstr: BSTR)

Frees a BSTR value.

impl<I: ComInterface + IClassFactory + ?Sized> IClassFactory for ComItf<I>

unsafe fn create_instance(
    &self,
    outer: RawComPtr,
    riid: REFIID
) -> ComResult<RawComPtr>

Safety

fn lock_server(&self, lock: bool) -> ComResult<()>

impl<I: ComInterface + IErrorInfo + ?Sized> IErrorInfo for ComItf<I>

fn get_description(&self) -> ComResult<String>

fn get_guid(&self) -> ComResult<GUID>

fn get_help_context(&self) -> ComResult<u32>

fn get_help_file(&self) -> ComResult<String>

fn get_source(&self) -> ComResult<String>

impl<I: ComInterface + IErrorStore + ?Sized> IErrorStore for ComItf<I>

fn get_error_info(&self) -> ComResult<Option<ComRc<dyn IErrorInfo>>>

fn set_error_info(&self, info: &ComItf<dyn IErrorInfo>) -> ComResult<()>

fn set_error_message(&self, msg: &str) -> ComResult<()>

impl<I: ComInterface + IIntercomCoClass + ?Sized> IIntercomCoClass for ComItf<I>

fn get_clsid(&self) -> ComResult<GUID>

fn get_interface_count(&self) -> ComResult<u32>

fn get_interface_ref(
    &self,
    idx: u32,
    ts: TypeSystemName
) -> ComResult<(String, GUID)>

fn get_name(&self) -> ComResult<String>

impl<I: ComInterface + IIntercomInterface + ?Sized> IIntercomInterface for ComItf<I>

fn get_name(&self) -> ComResult<String>

fn get_options(&self) -> ComResult<InterfaceOptions>

fn get_variant(
    &self,
    idx: u32
) -> ComResult<ComRc<dyn IIntercomInterfaceVariant>>

fn get_variant_count(&self) -> ComResult<u32>

impl<I: ComInterface + IIntercomInterfaceVariant + ?Sized> IIntercomInterfaceVariant for ComItf<I>

fn get_iid(&self) -> ComResult<GUID>

fn get_method(&self, idx: u32) -> ComResult<ComRc<dyn IIntercomMethod>>

fn get_method_count(&self) -> ComResult<u32>

fn get_type_system(&self) -> ComResult<TypeSystemName>

impl<I: ComInterface + IIntercomMethod + ?Sized> IIntercomMethod for ComItf<I>

fn get_name(&self) -> ComResult<String>

fn get_parameter(&self, idx: u32) -> ComResult<(String, String, u32, Direction)>

fn get_parameter_count(&self) -> ComResult<u32>

fn get_return_type(&self) -> ComResult<(String, u32)>

impl<I: ComInterface + IIntercomTypeInfo + ?Sized> IIntercomTypeInfo for ComItf<I>

fn get_kind(&self) -> ComResult<TypeInfoKind>

fn get_name(&self) -> ComResult<String>

impl<I: ComInterface + IIntercomTypeLib + ?Sized> IIntercomTypeLib for ComItf<I>

fn get_info(&self) -> ComResult<(String, GUID, String)>

fn get_type(&self, idx: u32) -> ComResult<ComRc<dyn IIntercomTypeInfo>>

fn get_type_count(&self) -> ComResult<u32>

impl<I: ComInterface + ISupportErrorInfo + ?Sized> ISupportErrorInfo for ComItf<I>

fn interface_supports_error_info(&self, riid: REFIID) -> HRESULT

Informs the current COM class supports IErrorInfo for a specific interface.

impl<I: ComInterface + RawIUnknown + ?Sized> RawIUnknown for ComItf<I>

fn add_ref(&self) -> u32

Increments the reference count of the object.

fn query_interface(&self, riid: REFIID) -> RawComResult<RawComPtr>

Tries to get a different COM interface for the current object.

fn release(&self) -> u32

Decreases the reference count of the object.

impl<T: ComInterface + ?Sized> ToOwned for ComItf<T>

type Owned = ComRc<T>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<I: ComInterface + IUnknown + ?Sized> IUnknown for ComItf<I>