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 provided pointer was created using the same type as pointer

Methods

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

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

Creates new instance from raw pointer and Deleter instance

Panics

• If pointer is null

pub 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.

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

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

Creates new instance from raw pointer and Deleter instance

Panics

• If pointer is null

pub 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 fn as_ptr(&self) -> *mut T

Gets underlying raw pointer.

pub fn as_ref(&self) -> &T

Gets reference to underlying object

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

Gets mutable reference to underlying object

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> Drop for Unique<T, D>

fn drop(&mut self)

Executes the destructor for this type.

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

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

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

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

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

Formats the value using the given formatter.