[−][src]Struct cpp_core::MutRef
A non-null, mutable pointer to a C++ object (similar to a C++ reference).
MutRef
never owns its content.
Note that unlike Rust references, MutRef
can be freely copied,
producing multiple mutable pointers to the same object, which is usually necessary
to do when working with C++ libraries.
MutRef
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+
.
MutRef
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.
If the object provides an iterator interface through begin()
and end()
functions,
MutRef
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 MutRef
exists. Note that
with MutRef
, 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
MutRef
in a safe interface.
Methods
impl<T> MutRef<T>
[src]
pub unsafe fn new(ptr: MutPtr<T>) -> Option<Self>
[src]
Creates a MutRef
from a MutPtr
. Returns None
if ptr
is null.
Safety
ptr
must be valid. See type level documentation.
pub unsafe fn from_raw(ptr: *mut T) -> Option<Self>
[src]
Creates a MutRef
from a raw pointer. Returns None
if ptr
is null.
Safety
ptr
must be valid. See type level documentation.
pub unsafe fn from_raw_ref(value: &mut T) -> Self
[src]
Creates a MutRef
from a raw reference.
Safety
value
must be alive as long as MutRef
or pointers derived from it are used.
See type level documentation.
pub unsafe fn from_raw_non_null(ptr: NonNull<T>) -> Self
[src]
pub unsafe fn as_ptr(self) -> Ptr<T>
[src]
pub unsafe fn as_mut_ptr(self) -> MutPtr<T>
[src]
pub fn as_raw_ptr(self) -> *const T
[src]
Returns constant raw pointer to the value.
pub fn as_mut_raw_ptr(self) -> *mut T
[src]
Returns mutable raw pointer to the value.
pub unsafe fn static_upcast<U>(self) -> Ref<U> where
T: StaticUpcast<U>,
[src]
T: StaticUpcast<U>,
Converts the pointer to the base class type U
.
Safety
This operation is safe as long as self
is valid.
pub unsafe fn static_downcast<U>(self) -> Ref<U> where
T: StaticDowncast<U>,
[src]
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
.
pub unsafe fn dynamic_cast<U>(self) -> Option<Ref<U>> where
T: DynamicCast<U>,
[src]
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.
pub unsafe fn static_upcast_mut<U>(self) -> MutRef<U> where
T: StaticUpcast<U>,
[src]
T: StaticUpcast<U>,
Converts the pointer to the base class type U
.
Safety
This operation is safe as long as self
is valid.
pub unsafe fn static_downcast_mut<U>(self) -> MutRef<U> where
T: StaticDowncast<U>,
[src]
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
.
pub unsafe fn dynamic_cast_mut<U>(self) -> Option<MutRef<U>> where
T: DynamicCast<U>,
[src]
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.
pub unsafe fn begin(self) -> <&'static T as Begin>::Output where
&'static T: Begin,
[src]
&'static T: Begin,
Returns a C++ const iterator object pointing to the beginning of the collection.
It's recommended to iterate directly on a MutRef<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,
[src]
&'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 MutRef<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,
[src]
&'static T: End,
Returns a C++ const iterator object pointing to the end of the collection.
It's recommended to iterate directly on a MutRef<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,
[src]
&'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 MutRef<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>>,
[src]
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>>,
[src]
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.
Trait Implementations
impl<T, U> CastFrom<MutRef<U>> for MutPtr<T> where
U: StaticUpcast<T>,
[src]
U: StaticUpcast<T>,
impl<T, U> CastFrom<MutRef<U>> for Ref<T> where
U: StaticUpcast<T>,
[src]
U: StaticUpcast<T>,
impl<T, U> CastFrom<MutRef<U>> for Ptr<T> where
U: StaticUpcast<T>,
[src]
U: StaticUpcast<T>,
impl<'a, T, U: CppDeletable> CastFrom<&'a mut CppBox<U>> for MutRef<T> where
U: StaticUpcast<T>,
[src]
U: StaticUpcast<T>,
impl<T, U> CastFrom<MutRef<U>> for MutRef<T> where
U: StaticUpcast<T>,
[src]
U: StaticUpcast<T>,
impl<T> Clone for MutRef<T>
[src]
Creates another pointer to the same object.
fn clone(&self) -> Self
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T, U> PartialOrd<U> for MutRef<T> where
T: Lt<U> + Le<U> + Gt<U> + Ge<U> + PartialEq<U>,
[src]
T: Lt<U> + Le<U> + Gt<U> + Ge<U> + PartialEq<U>,
fn partial_cmp(&self, other: &U) -> Option<Ordering>
[src]
fn lt(&self, other: &U) -> bool
[src]
fn le(&self, other: &U) -> bool
[src]
fn gt(&self, other: &U) -> bool
[src]
fn ge(&self, other: &U) -> bool
[src]
impl<T> Copy for MutRef<T>
[src]
Creates another pointer to the same object.
impl<T, T1, T2> IntoIterator for MutRef<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,
[src]
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
[src]
impl<T, U> PartialEq<U> for MutRef<T> where
T: PartialEq<U>,
[src]
T: PartialEq<U>,
impl<T> Deref for MutRef<T>
[src]
Allows to call member functions of T
and its base classes directly on the pointer.
impl<T> DerefMut for MutRef<T>
[src]
Allows to call member functions of T
and its base classes directly on the pointer.
impl<T> Debug for MutRef<T>
[src]
impl<T: 'static, U> Sub<U> for MutRef<T> where
&'static T: Sub<U>,
[src]
&'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
[src]
impl<T: 'static, U> Rem<U> for MutRef<T> where
&'static T: Rem<U>,
[src]
&'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
[src]
impl<T: 'static, U> Div<U> for MutRef<T> where
&'static T: Div<U>,
[src]
&'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
[src]
impl<T: 'static, U> Add<U> for MutRef<T> where
&'static T: Add<U>,
[src]
&'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
[src]
impl<T: 'static, U> Mul<U> for MutRef<T> where
&'static T: Mul<U>,
[src]
&'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
[src]
impl<T: 'static, U> AddAssign<U> for MutRef<T> where
T: AddAssign<U>,
[src]
T: AddAssign<U>,
fn add_assign(&mut self, rhs: U)
[src]
impl<T: 'static, U> SubAssign<U> for MutRef<T> where
T: SubAssign<U>,
[src]
T: SubAssign<U>,
fn sub_assign(&mut self, rhs: U)
[src]
impl<T: 'static, U> MulAssign<U> for MutRef<T> where
T: MulAssign<U>,
[src]
T: MulAssign<U>,
fn mul_assign(&mut self, rhs: U)
[src]
impl<T: 'static, U> DivAssign<U> for MutRef<T> where
T: DivAssign<U>,
[src]
T: DivAssign<U>,
fn div_assign(&mut self, rhs: U)
[src]
impl<T: 'static, U> RemAssign<U> for MutRef<T> where
T: RemAssign<U>,
[src]
T: RemAssign<U>,
fn rem_assign(&mut self, rhs: U)
[src]
impl<T: 'static, U> BitAnd<U> for MutRef<T> where
&'static T: BitAnd<U>,
[src]
&'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
[src]
impl<T: 'static, U> BitOr<U> for MutRef<T> where
&'static T: BitOr<U>,
[src]
&'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
[src]
impl<T: 'static, U> BitXor<U> for MutRef<T> where
&'static T: BitXor<U>,
[src]
&'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
[src]
impl<T: 'static, U> Shl<U> for MutRef<T> where
&'static T: Shl<U>,
[src]
&'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
[src]
impl<T: 'static, U> Shr<U> for MutRef<T> where
&'static T: Shr<U>,
[src]
&'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
[src]
impl<T: 'static, U> BitAndAssign<U> for MutRef<T> where
T: BitAndAssign<U>,
[src]
T: BitAndAssign<U>,
fn bitand_assign(&mut self, rhs: U)
[src]
impl<T: 'static, U> BitOrAssign<U> for MutRef<T> where
T: BitOrAssign<U>,
[src]
T: BitOrAssign<U>,
fn bitor_assign(&mut self, rhs: U)
[src]
impl<T: 'static, U> BitXorAssign<U> for MutRef<T> where
T: BitXorAssign<U>,
[src]
T: BitXorAssign<U>,
fn bitxor_assign(&mut self, rhs: U)
[src]
impl<T: 'static, U> ShlAssign<U> for MutRef<T> where
T: ShlAssign<U>,
[src]
T: ShlAssign<U>,
fn shl_assign(&mut self, rhs: U)
[src]
impl<T: 'static, U> ShrAssign<U> for MutRef<T> where
T: ShrAssign<U>,
[src]
T: ShrAssign<U>,
fn shr_assign(&mut self, rhs: U)
[src]
Auto Trait Implementations
impl<T> !Send for MutRef<T>
impl<T> !Sync for MutRef<T>
impl<T> Unpin for MutRef<T>
impl<T> RefUnwindSafe for MutRef<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<T> UnwindSafe for MutRef<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,