Struct autocxx::CppUniquePtrPin

pub struct CppUniquePtrPin<T: UniquePtrTarget>(_);

Any newtype wrapper which causes the contained UniquePtr target to obey C++ reference semantics rather than Rust reference semantics. That is, multiple aliasing mutable C++ references may exist to the contents.

C++ references are permitted to alias one another, and commonly do. Rust references must alias according only to the narrow rules of the borrow checker.

Implementations

impl<T: UniquePtrTarget> CppUniquePtrPin<T>

pub fn new(item: UniquePtr<T>) -> Self

Imprison the type within a CppPin. This eliminates any remaining Rust references (since we take the item by value) and this object subsequently only vends C++ style references, not Rust references.

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

Get an immutable pointer to the underlying object.

Trait Implementations

impl<T: UniquePtrTarget> AsCppMutRef<T> for CppUniquePtrPin<T>

fn as_cpp_mut_ref(&mut self) -> CppMutRef<'_, T>

Returns a mutable reference which obeys C++ reference semantics

impl<T: UniquePtrTarget> AsCppRef<T> for CppUniquePtrPin<T>

fn as_cpp_ref(&self) -> CppRef<'_, T>

Returns a reference which obeys C++ reference semantics