Struct Agile

pub struct Agile<I: Interface + AsIUnknown> { /* private fields */ }

A Send+Sync, IAgileReference-held interface pointer.

Implementations

impl<I: Interface + AsIUnknown> Agile<I>

pub fn try_from_eager(unk: impl AsRef<Rc<I>>) -> Result<Self, MethodHResult>

Eagerly marshal a COM interface for use in another apartment. Will fail if this is not possible.

pub fn try_from_lazy(unk: impl AsRef<Rc<I>>) -> Result<Self, MethodHResult>

Lazily marshal a COM interface for use in another thread. May fail when converted back into an Rc if in another COM apartment.

pub fn resolve(&self) -> Result<Rc<I>, MethodHResult>

[microsoft.com] Get a COM pointer to I that is safe to use from the current thread’s COM apartment

Trait Implementations

impl<I: Interface + AsIUnknown> AsRef<Agile<I>> for Agile<I>

fn as_ref(&self) -> &Self

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

impl<I: Interface + AsIUnknown> Clone for Agile<I>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Interface + AsIUnknown> TryFrom<&Agile<I>> for Rc<I>

type Error = MethodHResult

The type returned in the event of a conversion error.

fn try_from(value: &Agile<I>) -> Result<Self, Self::Error>

Performs the conversion.

impl<I: Interface + AsIUnknown> TryFrom<&Rc<I>> for Agile<I>

type Error = MethodHResult

The type returned in the event of a conversion error.

fn try_from(value: &Rc<I>) -> Result<Self, Self::Error>

Performs the conversion.

impl<I: Interface + AsIUnknown> TryFrom<Agile<I>> for Rc<I>

type Error = MethodHResult

The type returned in the event of a conversion error.

fn try_from(value: Agile<I>) -> Result<Self, Self::Error>

Performs the conversion.

impl<I: Interface + AsIUnknown> TryFrom<Rc<I>> for Agile<I>

type Error = MethodHResult

The type returned in the event of a conversion error.

fn try_from(value: Rc<I>) -> Result<Self, Self::Error>

Performs the conversion.

impl<I: Interface + AsIUnknown> Send for Agile<I>

impl<I: Interface + AsIUnknown> Sync for Agile<I>

Safety

The entire point of an IAgileReference, like Agile contains is that it can be safely shared between multiple threads, even if they don’t belong to the same COM apartment, even if the original interface pointer was apartment-specific. As such, Agile should be safe to mark Send+Sync.

• Types which implement IAgileObject will remain unwrapped
• Types which implement INoMarshal will fail to convert to Agile in the first place
• Types which implement neither will be wrapped in lightweight in-process-only marshaling