Struct cxx::UniquePtr [−][src]
#[repr(C)]pub struct UniquePtr<T> where
T: UniquePtrTarget, { /* fields omitted */ }
Binding to C++ std::unique_ptr<T, std::default_delete<T>>
.
Implementations
impl<T> UniquePtr<T> where
T: UniquePtrTarget,
[src]
impl<T> UniquePtr<T> where
T: UniquePtrTarget,
[src]pub fn null() -> Self
[src]
Makes a new UniquePtr wrapping a null pointer.
Matches the behavior of default-constructing a std::unique_ptr.
pub fn new(value: T) -> Self where
T: ExternType<Kind = Trivial>,
[src]
T: ExternType<Kind = Trivial>,
Allocates memory on the heap and makes a UniquePtr pointing to it.
pub fn is_null(&self) -> bool
[src]
Checks whether the UniquePtr does not own an object.
This is the opposite of std::unique_ptr<T>::operator bool.
pub fn as_ref(&self) -> Option<&T>
[src]
Returns a reference to the object owned by this UniquePtr if any, otherwise None.
pub fn as_mut(&mut self) -> Option<Pin<&mut T>>
[src]
Returns a mutable pinned reference to the object owned by this UniquePtr if any, otherwise None.
pub fn pin_mut(&mut self) -> Pin<&mut T>
[src]
Returns a mutable pinned reference to the object owned by this UniquePtr.
Panics
Panics if the UniquePtr holds a null pointer.
pub fn into_raw(self) -> *mut T
[src]
Consumes the UniquePtr, releasing its ownership of the heap-allocated T.
Matches the behavior of std::unique_ptr<T>::release.
pub unsafe fn from_raw(raw: *mut T) -> Self
[src]
Constructs a UniquePtr retaking ownership of a pointer previously
obtained from into_raw
.
Safety
This function is unsafe because improper use may lead to memory problems. For example a double-free may occur if the function is called twice on the same raw pointer.
Trait Implementations
impl<T> Debug for UniquePtr<T> where
T: Debug + UniquePtrTarget,
[src]
impl<T> Debug for UniquePtr<T> where
T: Debug + UniquePtrTarget,
[src]impl<T> Deref for UniquePtr<T> where
T: UniquePtrTarget,
[src]
impl<T> Deref for UniquePtr<T> where
T: UniquePtrTarget,
[src]impl<T> DerefMut for UniquePtr<T> where
T: UniquePtrTarget + Unpin,
[src]
impl<T> DerefMut for UniquePtr<T> where
T: UniquePtrTarget + Unpin,
[src]impl<T> Display for UniquePtr<T> where
T: Display + UniquePtrTarget,
[src]
impl<T> Display for UniquePtr<T> where
T: Display + UniquePtrTarget,
[src]impl<T> Send for UniquePtr<T> where
T: Send + UniquePtrTarget,
[src]
impl<T> Send for UniquePtr<T> where
T: Send + UniquePtrTarget,
[src]impl<T> Sync for UniquePtr<T> where
T: Sync + UniquePtrTarget,
[src]
impl<T> Sync for UniquePtr<T> where
T: Sync + UniquePtrTarget,
[src]Auto Trait Implementations
impl<T> RefUnwindSafe for UniquePtr<T> where
T: RefUnwindSafe,
impl<T> RefUnwindSafe for UniquePtr<T> where
T: RefUnwindSafe,
impl<T> UnwindSafe for UniquePtr<T> where
T: UnwindSafe,
impl<T> UnwindSafe for UniquePtr<T> where
T: UnwindSafe,