Struct vst3::ComWrapper

pub struct ComWrapper<C>
where
    C: Class,
{ /* private fields */ }

A wrapper for constructing a reference-counted COM object from a Rust value.

ComWrapper represents an owning reference to the COM object, i.e. it will decrement the object’s reference count when it goes out of scope.

Implementations

impl<C> ComWrapper<C>

where C: Class,

pub fn new(data: C) -> ComWrapper<C>

where C: 'static, <C as Class>::Interfaces: MakeHeader<C, ComWrapper<C>>,

Allocates memory for an object and its header and places data into it.

pub fn as_com_ref<I, 'a>(&'a self) -> Option<ComRef<'a, I>>

where I: Interface,

If I is in C’s interface list, returns a ComRef<I> pointing to the object.

Does not perform any reference counting operations.

pub fn to_com_ptr<I>(&self) -> Option<ComPtr<I>>

where I: Interface,

If I is in C’s interface list, returns a ComPtr<I> pointing to the object.

If a ComPtr is returned, the object’s reference count will be incremented.

Trait Implementations

impl<C> Clone for ComWrapper<C>

where C: Class,

fn clone(&self) -> ComWrapper<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Deref for ComWrapper<C>

where C: Class,

type Target = C

The resulting type after dereferencing.

fn deref(&self) -> &<ComWrapper<C> as Deref>::Target

Dereferences the value.

impl<C> Wrapper<C> for ComWrapper<C>

where C: Class,

unsafe fn data_from_header( ptr: *mut <<C as Class>::Interfaces as InterfaceList>::Header ) -> *mut C

Given a pointer to an object’s header, returns a pointer to the object itself.

unsafe fn header_from_data( ptr: *mut C ) -> *mut <<C as Class>::Interfaces as InterfaceList>::Header

Given a pointer to an object, returns a pointer to the object’s header.

unsafe fn add_ref(ptr: *mut C) -> usize

Increments the reference count of an object and returns the resulting count.

unsafe fn release(ptr: *mut C) -> usize

Decrements the reference count of an object and returns the resulting count.

impl<C> Send for ComWrapper<C>

where C: Class + Send + Sync,

impl<C> Sync for ComWrapper<C>

where C: Class + Send + Sync,