Struct smart_ptr::unique::Unique

pub struct Unique<T, D> where
    D: Deleter,  { /* fields omitted */ }

Smart pointer, that owns and manages object via its pointer.

On Drop it automatically disposes of pointer with provided deleter.

Useful in C FFI context.

Safety

If you use Deleter that relies on type information, you must guarantee that object was created using the same type as pointer, which points to it.

Which means you must guarantee that specified pointer is valid one and points to existing memory storage, which is already initialized.

Implementations

impl<T> Unique<T, DefaultDeleter>

pub fn boxed(val: T) -> Self

Creates new instance using global allocator

pub fn into_boxed(self) -> Box<T>

Converts ptr to box

impl<T, D: Default + Deleter> Unique<T, D>

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

Creates new instance from raw pointer and Deleter instance

Panics

• If pointer is null

pub unsafe fn from_ptr_default(ptr: *mut T) -> Option<Self>

Creates instance from raw pointer, checking if pointer is null.

Returns None if pointer is null.

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

Creates instance from raw pointer, without checking if pointer is null.

User must ensure that pointer is non-null

impl<T, D: Deleter> Unique<T, D>

pub unsafe fn new(ptr: *mut T, deleter: D) -> Self

Creates new instance from raw pointer and Deleter instance

Panics

• If pointer is null

pub unsafe fn from_ptr(ptr: *mut T, deleter: D) -> Option<Self>

Creates instance from raw pointer, checking if pointer is null.

Returns None if pointer is null.

pub unsafe fn from_ptr_unchecked(ptr: *mut T, deleter: D) -> Self

Creates instance from raw pointer, without checking if pointer is null.

User must ensure that pointer is non-null

pub fn get(&self) -> *mut T

Gets underlying raw pointer.

pub fn as_ref(&self) -> &T

Gets reference to underlying data.

pub fn as_mut(&mut self) -> &mut T

Gets mutable reference to underlying data.

pub fn get_deleter(&mut self) -> &mut D

Gets underlying deleter

pub fn cast<N>(&self) -> *mut N

Retrieves pointer as of type

pub fn const_cast<N>(&self) -> *const N

Retrieves pointer as of type and const

pub fn swap(&mut self, other: &mut Self)

Swaps underlying pointers between instances

pub fn release(self) -> NonNull<T>

Releases the ownership and returns raw pointer, without dropping it.

Trait Implementations

impl<T, D: Deleter> Debug for Unique<T, D>

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

Formats the value using the given formatter.

impl<T, D: Deleter> Deref for Unique<T, D>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, D: Deleter> DerefMut for Unique<T, D>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T, D: Deleter> Drop for Unique<T, D>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, D: Deleter> Hash for Unique<T, D>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T, D: Deleter> Pointer for Unique<T, D>

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

Formats the value using the given formatter.

impl<T: Send, D: Deleter + Send> Send for Unique<T, D>

impl<T: Sync, D: Deleter + Sync> Sync for Unique<T, D>

impl<T: Unpin, D: Deleter + Unpin> Unpin for Unique<T, D>