Struct CppMutRef 

pub struct CppMutRef<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<T: ?Sized> CppMutRef<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.

Methods from Deref<Target = CppRef<T>>

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

Retrieve the underlying C++ pointer.

pub unsafe fn as_ref(&self) -> &T

Get a regular Rust 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 mutable 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 const_cast(&self) -> CppMutRef<T>

Create a mutable version of this reference, roughly equivalent to C++ const_cast.

The opposite is to use AsCppRef::as_cpp_ref on a CppMutRef to obtain a CppRef.

Safety

Because we never dereference a CppRef in Rust, this cannot create undefined behavior within Rust and is therefore not unsafe. It is however generally unwise, just as it is in C++. Use sparingly.

Trait Implementations

impl<T: ?Sized> AsCppRef<T> for CppMutRef<T>

fn as_cpp_ref(&self) -> CppRef<T>

Returns a reference which obeys C++ reference semantics

impl<T: ?Sized> Clone for CppMutRef<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> Copy for CppMutRef<T>

impl<T: ?Sized> Deref for CppMutRef<T>

We implement Deref for CppMutRef so that any non-mutable methods can be called on a CppMutRef instance.

type Target = CppRef<T>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> From<CppMutRef<T>> for CppRef<T>

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

Converts to this type from the input type.