Struct Unique

pub struct Unique<T: ?Sized, A: Allocator = GlobalAllocator> { /* private fields */ }

An allocator-aware smart pointer similar to C++’s unique_ptr.

Usage

let pointer = Unique::new(100_000);
let num = *pointer;

TODO: Write better documentation.

Implementations

impl<T, A: Allocator> Unique<T, A>

pub fn new_with(value: T, allocator: A) -> Self

pub fn pin_with(value: T, allocator: A) -> Pin<Self>

impl<T: ?Sized, A: Allocator> Unique<T, A>

pub unsafe fn from_raw_with(pointer: NonNull<T>, allocator: A) -> Self

pub fn leak<'a>(unique: Unique<T, A>) -> &'a mut T

where A: 'a,

pub fn into_raw(unique: Self) -> *mut T

impl<T> Unique<T, GlobalAllocator>

pub fn new(value: T) -> Self

pub fn pin(value: T) -> Pin<Self>

Trait Implementations

impl<T: ?Sized, A: Allocator> AsMut<T> for Unique<T, A>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: ?Sized, A: Allocator> AsRef<T> for Unique<T, A>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: ?Sized, A: Allocator> Borrow<T> for Unique<T, A>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: ?Sized, A: Allocator> BorrowMut<T> for Unique<T, A>

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value.

impl<T: ?Sized, A: Allocator> DerefMut for Unique<T, A>

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

Mutably dereferences the value.

impl<T: ?Sized, A: Allocator> Drop for Unique<T, A>

fn drop(&mut self)

Executes the destructor for this type.

impl From<&str> for Unique<dyn BaseError>

fn from(value: &str) -> Self

Converts a str into a unique pointer of dyn BaseError.

impl<'a> From<&str> for Unique<dyn BaseError + Send + Sync + 'a>

fn from(value: &str) -> Self

Converts a str into a unique pointer of dyn BaseError + Send + Sync.

impl<'a, E: BaseError + 'a> From<E> for Unique<dyn BaseError + 'a>

fn from(value: E) -> Self

Converts a type of BaseError + Send + Sync into a unique pointer of dyn BaseError + Send + Sync.

impl From<String> for Unique<dyn BaseError>

fn from(value: String) -> Self

Converts a String into a unique pointer of dyn BaseError.

impl From<String> for Unique<dyn BaseError + Send + Sync>

fn from(value: String) -> Self

Converts a String into a unique pointer of dyn BaseError + Send + Sync.

impl<T: ?Sized, A: Allocator> Deref for Unique<T, A>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized + Unsize<U>, U: ?Sized, A: Allocator> CoerceUnsized<Unique<U, A>> for Unique<T, A>

impl<T: ?Sized, A: Allocator> Unpin for Unique<T, A>