Struct autocxx::CppMutRef

#[repr(transparent)]
pub struct CppMutRef<'a, T: ?Sized> { /* private fields */ }

A C++ non-const reference. These are different from Rust’s &mut T in that several C++ references can exist to the same underlying data (“aliasing”) and that’s not permitted for regular Rust references.

See CppRef for details on safety, usage models and implementation.

You can convert this to a CppRef using the std::convert::Into trait.

Implementations

impl<'a, T: ?Sized> CppMutRef<'a, T>

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

Retrieve the underlying C++ pointer.

pub unsafe fn as_mut(&mut self) -> &mut T

Get a regular Rust mutable reference out of this C++ reference.

Safety

Callers must guarantee that the referent is not modified by any other C++ or Rust code while the returned reference exists. Callers must also guarantee that no other Rust reference is created to the referent while the returned reference exists.

Callers must also be sure that the C++ reference is properly aligned, not null, pointing to valid data, etc.

pub fn from_ptr(ptr: *mut T) -> Self

Create a C++ reference from a raw pointer.

pub fn lifetime_cast(&mut self) -> PhantomReferentMut<T>

Extend the lifetime of the returned reference beyond normal Rust borrow checker rules. See CppRef::lifetime_cast.

Trait Implementations

impl<'a, T: ?Sized> AsCppRef<T> for CppMutRef<'a, T>

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

Returns a reference which obeys C++ reference semantics

impl<'a, T: ?Sized> Clone for CppMutRef<'a, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: ?Sized> Deref for CppMutRef<'a, T>

type Target = *const T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T> From<CppMutRef<'a, T>> for CppRef<'a, T>

fn from(mutable: CppMutRef<'a, T>) -> Self

Converts to this type from the input type.

impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<CppMutRef<'_, U>> for CppMutRef<'_, T>