Struct MutPtr

pub struct MutPtr<T>(/* private fields */);

A mutable pointer to a C++ object (similar to a C++ pointer).

A MutPtr may or may not be owned. If you actually own the object, it’s recommended to convert it to CppBox using to_box method.

Note that unlike Rust references, MutPtr can be freely copied, producing multiple mutable pointers to the same object, which is usually necessary to do when working with C++ libraries.

MutPtr implements operator traits and delegates them to the corresponding C++ operators. This means that you can use &ptr + value to access the object’s operator+.

MutPtr implements Deref and DerefMut, allowing to call the object’s methods directly. In addition, methods of the object’s first base class are also directly available thanks to nested Deref implementations.

MutPtr can contain a null pointer. Deref will panic if attempted to dereference a null pointer.

If the object provides an iterator interface through begin() and end() functions, MutPtr will implement IntoIterator, so you can iterate on it directly.

Safety

It’s not possible to automatically track the ownership of objects possibly managed by C++ libraries. The user must ensure that the object is alive while MutPtr exists. Note that with MutPtr, it’s possible to call unsafe C++ code without using any more unsafe Rust code, for example, by using operator traits, so care should be taken when exposing MutPtr in a safe interface.

Null pointers must not be dereferenced.

Implementations

impl<T> MutPtr<T>

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

Creates a MutPtr from a raw pointer.

Safety

See type level documentation.

pub unsafe fn null() -> Self

Creates a null pointer.

Note that you can also use NullPtr to specify a null pointer to a function accepting impl CastInto<MutPtr<_>>. Unlike MutPtr, NullPtr is not a generic type, so it will not cause type inference issues.

Safety

Null pointers must not be dereferenced. See type level documentation.

pub fn as_raw_ptr(self) -> *const T

Returns the content as a raw const pointer.

pub fn as_mut_raw_ptr(self) -> *mut T

Returns the content as a raw mutable pointer.

pub unsafe fn as_ptr(self) -> Ptr<T>

Returns the content as a const Ptr.

Safety

The operation is safe as long as self is valid or null. See type level documentation.

pub unsafe fn as_ref(self) -> Option<Ref<T>>

Returns the content as a const Ref. Returns None if self is a null pointer.

Safety

The operation is safe as long as self is valid or null. See type level documentation.

pub unsafe fn as_mut_ref(self) -> Option<MutRef<T>>

Returns the content as a MutRef. Returns None if self is a null pointer.

Safety

The operation is safe as long as self is valid or null. See type level documentation.

pub fn is_null(self) -> bool

Returns true if the pointer is null.

pub unsafe fn static_upcast<U>(self) -> Ptr<U>

where T: StaticUpcast<U>,

Converts the pointer to the base class type U.

Safety

This operation is safe as long as self is valid or null.

pub unsafe fn static_downcast<U>(self) -> Ptr<U>

where T: StaticDowncast<U>,

Converts the pointer to the derived class type U.

It’s recommended to use dynamic_cast instead because it performs a checked conversion.

Safety

This operation is safe as long as self is valid and it’s type is U or inherits from U, of if self is a null pointer.

pub unsafe fn dynamic_cast<U>(self) -> Ptr<U>

where T: DynamicCast<U>,

Converts the pointer to the derived class type U. Returns None if the object’s type is not U and doesn’t inherit U.

Safety

This operation is safe as long as self is valid or null.

pub unsafe fn static_upcast_mut<U>(self) -> MutPtr<U>

where T: StaticUpcast<U>,

Converts the pointer to the base class type U.

Safety

This operation is safe as long as self is valid or null.

pub unsafe fn static_downcast_mut<U>(self) -> MutPtr<U>

where T: StaticDowncast<U>,

Converts the pointer to the derived class type U.

It’s recommended to use dynamic_cast instead because it performs a checked conversion.

Safety

This operation is safe as long as self is valid and it’s type is U or inherits from U, of if self is a null pointer.

pub unsafe fn dynamic_cast_mut<U>(self) -> MutPtr<U>

where T: DynamicCast<U>,

Converts the pointer to the derived class type U. Returns None if the object’s type is not U and doesn’t inherit U.

Safety

This operation is safe as long as self is valid or null.

pub unsafe fn begin(self) -> <&'static T as Begin>::Output

where &'static T: Begin,

Returns a C++ const iterator object pointing to the beginning of the collection.

It’s recommended to iterate directly on a MutPtr<T> when possible, using automatic IntoIterator implementation.

Safety

self must be valid. It’s not possible to make any guarantees about safety, since this function calls arbitrary C++ library code.

pub unsafe fn begin_mut(self) -> <&'static mut T as BeginMut>::Output

where &'static mut T: BeginMut,

Returns a C++ mutable iterator object pointing to the beginning of the collection.

It’s recommended to iterate directly on a MutPtr<T> when possible, using automatic IntoIterator implementation.

Safety

self must be valid. It’s not possible to make any guarantees about safety, since this function calls arbitrary C++ library code.

pub unsafe fn end(self) -> <&'static T as End>::Output

where &'static T: End,

Returns a C++ const iterator object pointing to the end of the collection.

It’s recommended to iterate directly on a MutPtr<T> when possible, using automatic IntoIterator implementation.

Safety

self must be valid. It’s not possible to make any guarantees about safety, since this function calls arbitrary C++ library code.

pub unsafe fn end_mut(self) -> <&'static mut T as EndMut>::Output

where &'static mut T: EndMut,

Returns a C++ mutable iterator object pointing to the end of the collection.

It’s recommended to iterate directly on a MutPtr<T> when possible, using automatic IntoIterator implementation.

Safety

self must be valid. It’s not possible to make any guarantees about safety, since this function calls arbitrary C++ library code.

pub unsafe fn as_slice<'a, T1>(self) -> &'a [T1]

where T: 'static, &'static T: Begin<Output = Ptr<T1>> + End<Output = Ptr<T1>>,

Returns a slice corresponding to the object. This function is available when begin() and end() functions of the object return pointers.

Safety

self must be valid. It’s not possible to make any guarantees about safety, since this function calls arbitrary C++ library code. It’s not recommended to store the slice because it may be modified by the C++ library, which would violate Rust’s aliasing rules.

pub unsafe fn as_mut_slice<'a, T1>(self) -> &'a mut [T1]

where T: 'static, &'static mut T: BeginMut<Output = MutPtr<T1>> + EndMut<Output = MutPtr<T1>>,

Returns a mutable slice corresponding to the object. This function is available when begin() and end() functions of the object return pointers.

Safety

self must be valid. It’s not possible to make any guarantees about safety, since this function calls arbitrary C++ library code. It’s not recommended to store the slice because it may be modified by the C++ library, which would violate Rust’s aliasing rules.

impl<T: CppDeletable> MutPtr<T>

pub unsafe fn to_box(self) -> Option<CppBox<T>>

Converts this pointer to a CppBox. Returns None if self is a null pointer.

Use this function to take ownership of the object. This is the same as CppBox::new.

impl MutPtr<c_char>

pub unsafe fn from_c_str(str: &CStr) -> Self

Creates a MutPtr<c_char>, i.e. C++’s char* from a CStr.

Safety

The source str must be valid while MutPtr exists and while it’s used by the C++ library.

After passing str to MutPtr, it’s unsafe to use str and any references to the same buffer from Rust because the memory can be modified through MutPtr.

pub unsafe fn to_c_str<'a>(self) -> &'a CStr

Converts MutPtr<c_char>, i.e. C++’s char* to a &CStr.

Safety

No guarantees can be made about the validity and lifetime of the buffer, since it could be produced by a C++ library.

Trait Implementations

impl<T: 'static, U> Add<U> for MutPtr<T>

where &'static T: Add<U>,

type Output = <&'static T as Add<U>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: U) -> Self::Output

Performs the + operation.

impl<T, U> AddAssign<U> for MutPtr<T>

where T: AddAssign<U> + 'static,

fn add_assign(&mut self, rhs: U)

Performs the += operation.

impl<T: 'static, U> BitAnd<U> for MutPtr<T>

where &'static T: BitAnd<U>,

type Output = <&'static T as BitAnd<U>>::Output

The resulting type after applying the & operator.

fn bitand(self, rhs: U) -> Self::Output

Performs the & operation.

impl<T, U> BitAndAssign<U> for MutPtr<T>

where T: BitAndAssign<U> + 'static,

fn bitand_assign(&mut self, rhs: U)

Performs the &= operation.

impl<T: 'static, U> BitOr<U> for MutPtr<T>

where &'static T: BitOr<U>,

type Output = <&'static T as BitOr<U>>::Output

The resulting type after applying the | operator.

fn bitor(self, rhs: U) -> Self::Output

Performs the | operation.

impl<T, U> BitOrAssign<U> for MutPtr<T>

where T: BitOrAssign<U> + 'static,

fn bitor_assign(&mut self, rhs: U)

Performs the |= operation.

impl<T: 'static, U> BitXor<U> for MutPtr<T>

where &'static T: BitXor<U>,

type Output = <&'static T as BitXor<U>>::Output

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: U) -> Self::Output

Performs the ^ operation.

impl<T, U> BitXorAssign<U> for MutPtr<T>

where T: BitXorAssign<U> + 'static,

fn bitxor_assign(&mut self, rhs: U)

Performs the ^= operation.

impl<'a> CastFrom<&'a CStr> for MutPtr<c_char>

unsafe fn cast_from(value: &'a CStr) -> Self

Performs the conversion.

impl<'a, T, U> CastFrom<&'a mut CppBox<U>> for MutPtr<T>

where U: StaticUpcast<T> + CppDeletable,

unsafe fn cast_from(value: &'a mut CppBox<U>) -> Self

Performs the conversion.

impl<T, U> CastFrom<*mut U> for MutPtr<T>

where U: StaticUpcast<T>,

unsafe fn cast_from(value: *mut U) -> Self

Performs the conversion.

impl<T, U> CastFrom<MutPtr<U>> for MutPtr<T>

where U: StaticUpcast<T>,

unsafe fn cast_from(value: MutPtr<U>) -> Self

Performs the conversion.

impl<T, U> CastFrom<MutPtr<U>> for Ptr<T>

where U: StaticUpcast<T>,

unsafe fn cast_from(value: MutPtr<U>) -> Self

Performs the conversion.

impl<T, U> CastFrom<MutRef<U>> for MutPtr<T>

where U: StaticUpcast<T>,

unsafe fn cast_from(value: MutRef<U>) -> Self

Performs the conversion.

impl<T> CastFrom<NullPtr> for MutPtr<T>

unsafe fn cast_from(_value: NullPtr) -> Self

Performs the conversion.

impl<T> Clone for MutPtr<T>

Creates another pointer to the same object.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for MutPtr<T>

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

Formats the value using the given formatter.

impl<T> Deref for MutPtr<T>

Allows to call member functions of T and its base classes directly on the pointer.

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for MutPtr<T>

Allows to call member functions of T and its base classes directly on the pointer.

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T: 'static, U> Div<U> for MutPtr<T>

where &'static T: Div<U>,

type Output = <&'static T as Div<U>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: U) -> Self::Output

Performs the / operation.

impl<T, U> DivAssign<U> for MutPtr<T>

where T: DivAssign<U> + 'static,

fn div_assign(&mut self, rhs: U)

Performs the /= operation.

impl<T, T1, T2> IntoIterator for MutPtr<T>

where T: 'static, &'static mut T: BeginMut<Output = CppBox<T1>> + EndMut<Output = CppBox<T2>>, T1: CppDeletable + PartialEq<Ref<T2>> + 'static, T2: CppDeletable, &'static T1: Indirection, &'static mut T1: Increment,

type Item = <&'static T1 as Indirection>::Output

The type of the elements being iterated over.

type IntoIter = CppIterator<T1, T2>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: 'static, U> Mul<U> for MutPtr<T>

where &'static T: Mul<U>,

type Output = <&'static T as Mul<U>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: U) -> Self::Output

Performs the * operation.

impl<T, U> MulAssign<U> for MutPtr<T>

where T: MulAssign<U> + 'static,

fn mul_assign(&mut self, rhs: U)

Performs the *= operation.

impl<T, U> PartialEq<U> for MutPtr<T>

where T: PartialEq<U>,

fn eq(&self, rhs: &U) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, U> PartialOrd<U> for MutPtr<T>

where T: Lt<U> + Le<U> + Gt<U> + Ge<U> + PartialEq<U>,

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

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

fn lt(&self, other: &U) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &U) -> bool

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

fn gt(&self, other: &U) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &U) -> bool

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

impl<T: 'static, U> Rem<U> for MutPtr<T>

where &'static T: Rem<U>,

type Output = <&'static T as Rem<U>>::Output

The resulting type after applying the % operator.

fn rem(self, rhs: U) -> Self::Output

Performs the % operation.

impl<T, U> RemAssign<U> for MutPtr<T>

where T: RemAssign<U> + 'static,

fn rem_assign(&mut self, rhs: U)

Performs the %= operation.

impl<T: 'static, U> Shl<U> for MutPtr<T>

where &'static T: Shl<U>,

type Output = <&'static T as Shl<U>>::Output

The resulting type after applying the << operator.

fn shl(self, rhs: U) -> Self::Output

Performs the << operation.

impl<T, U> ShlAssign<U> for MutPtr<T>

where T: ShlAssign<U> + 'static,

fn shl_assign(&mut self, rhs: U)

Performs the <<= operation.

impl<T: 'static, U> Shr<U> for MutPtr<T>

where &'static T: Shr<U>,

type Output = <&'static T as Shr<U>>::Output

The resulting type after applying the >> operator.

fn shr(self, rhs: U) -> Self::Output

Performs the >> operation.

impl<T, U> ShrAssign<U> for MutPtr<T>

where T: ShrAssign<U> + 'static,

fn shr_assign(&mut self, rhs: U)

Performs the >>= operation.

impl<T: 'static, U> Sub<U> for MutPtr<T>

where &'static T: Sub<U>,

type Output = <&'static T as Sub<U>>::Output

The resulting type after applying the - operator.

fn sub(self, rhs: U) -> Self::Output

Performs the - operation.

impl<T, U> SubAssign<U> for MutPtr<T>

where T: SubAssign<U> + 'static,

fn sub_assign(&mut self, rhs: U)

Performs the -= operation.

impl<T> Copy for MutPtr<T>

Creates another pointer to the same object.