Struct com_ptr::ComPtr

pub struct ComPtr<T: Interface> { /* fields omitted */ }

A smart pointer for COM Interfaces.

Methods

impl<T: Interface> ComPtr<T>

pub fn new<F, E>(f: F) -> Result<ComPtr<T>, E> where
    F: FnOnce() -> Result<*mut T, E>, 

Creates a new ComPtr from a closure.

Safety

'f' must returns non-null.

pub unsafe fn from_raw(ptr: *mut T) -> ComPtr<T>

Creates a new ComPtr from a raw pointer.

Safety

'ptr' must be non-null.

pub fn as_ptr(&self) -> *mut T

Returns a pointer

pub fn as_ref(&self) -> &T

Returns a reference

pub fn query_interface<U: Interface>(&self) -> Result<ComPtr<U>, HRESULT>

Returns a ComPtr<U> when interface T support interface U.

Trait Implementations

impl<T: Interface> Sync for ComPtr<T>

impl<T: Interface> PartialOrd<ComPtr<T>> for ComPtr<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Interface> Send for ComPtr<T>

impl<T: Interface> Eq for ComPtr<T>

impl<T: Interface> PartialEq<ComPtr<T>> for ComPtr<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Interface> Ord for ComPtr<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: Interface> Drop for ComPtr<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Interface> Clone for ComPtr<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: Interface> Deref for ComPtr<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Interface> Debug for ComPtr<T>

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

Formats the value using the given formatter.