[][src]Struct cpp_core::Ref

pub struct Ref<T>(_);

A non-null, mutable pointer to a C++ object (similar to a C++ reference).

Ref never owns its content.

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

Ref 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+.

Ref 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, Ref 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 Ref exists. Note that with Ref, 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 Ref in a safe interface.

Methods

impl<T> Ref<T>[src]

pub unsafe fn new(ptr: Ptr<T>) -> Option<Self>[src]

Creates a Ref from a Ptr. Returns None if ptr is null.

Safety

ptr must be valid. See type level documentation.

pub unsafe fn from_raw(ptr: *const T) -> Option<Self>[src]

Creates a Ref 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: &T) -> Self[src]

Creates a Ref from a raw reference.

Safety

value must be alive as long as Ref or pointers derived from it are used. See type level documentation.

pub unsafe fn from_raw_non_null(ptr: NonNull<T>) -> Self[src]

Creates a Ref from a non-null pointer.

Safety

ptr must be valid. See type level documentation.

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

Converts self to a Ptr.

Safety

self must be valid. See type level documentation.

pub fn as_raw_ptr(self) -> *const T[src]

Returns constant raw pointer to the value.

pub unsafe fn static_upcast<U>(self) -> Ref<U> where
    T: StaticUpcast<U>, 
[src]

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]

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]

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.

Trait Implementations

impl<T, U> CastFrom<Ref<U>> for Ptr<T> where
    U: StaticUpcast<T>, 
[src]

impl<T, U> CastFrom<MutRef<U>> for Ref<T> where
    U: StaticUpcast<T>, 
[src]

impl<'a, T, U: CppDeletable> CastFrom<&'a CppBox<U>> for Ref<T> where
    U: StaticUpcast<T>, 
[src]

impl<T, U> CastFrom<Ref<U>> for Ref<T> where
    U: StaticUpcast<T>, 
[src]

impl<T, T1, T2> IntoIterator for Ref<T> where
    T: Begin<Output = CppBox<T1>> + End<Output = CppBox<T2>>,
    T1: CppDeletable + PartialEq<Ref<T2>> + Indirection + Increment,
    T2: CppDeletable
[src]

type Item = <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?

impl<T> Clone for Ref<T>[src]

Creates another pointer to the same object.

impl<T> Copy for Ref<T>[src]

Creates another pointer to the same object.

impl<T, U> PartialEq<U> for Ref<T> where
    T: PartialEq<U>, 
[src]

impl<T, U> PartialOrd<U> for Ref<T> where
    T: Lt<U> + Le<U> + Gt<U> + Ge<U> + PartialEq<U>, 
[src]

impl<T> Debug for Ref<T>[src]

impl<T: 'static, U> Div<U> for Ref<T> where
    &'static T: Div<U>, 
[src]

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

The resulting type after applying the / operator.

impl<T: 'static, U> Rem<U> for Ref<T> where
    &'static T: Rem<U>, 
[src]

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

The resulting type after applying the % operator.

impl<T: 'static, U> Sub<U> for Ref<T> where
    &'static T: Sub<U>, 
[src]

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

The resulting type after applying the - operator.

impl<T: 'static, U> Add<U> for Ref<T> where
    &'static T: Add<U>, 
[src]

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

The resulting type after applying the + operator.

impl<T: 'static, U> Mul<U> for Ref<T> where
    &'static T: Mul<U>, 
[src]

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

The resulting type after applying the * operator.

impl<T: 'static, U> BitAnd<U> for Ref<T> where
    &'static T: BitAnd<U>, 
[src]

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

The resulting type after applying the & operator.

impl<T: 'static, U> BitOr<U> for Ref<T> where
    &'static T: BitOr<U>, 
[src]

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

The resulting type after applying the | operator.

impl<T: 'static, U> BitXor<U> for Ref<T> where
    &'static T: BitXor<U>, 
[src]

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

The resulting type after applying the ^ operator.

impl<T: 'static, U> Shl<U> for Ref<T> where
    &'static T: Shl<U>, 
[src]

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

The resulting type after applying the << operator.

impl<T: 'static, U> Shr<U> for Ref<T> where
    &'static T: Shr<U>, 
[src]

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

The resulting type after applying the >> operator.

impl<T> Deref for Ref<T>[src]

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

type Target = T

The resulting type after dereferencing.

Auto Trait Implementations

impl<T> !Send for Ref<T>

impl<T> !Sync for Ref<T>

impl<T> Unpin for Ref<T>

impl<T> UnwindSafe for Ref<T> where
    T: RefUnwindSafe

impl<T> RefUnwindSafe for Ref<T> where
    T: RefUnwindSafe

Blanket Implementations

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<I> IntoIterator for I where
    I: Iterator
[src]

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = I

Which kind of iterator are we turning this into?

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]