Struct alloc::boxed::PinBox

[+] Show type declaration

pub struct PinBox<T: ?Sized> { /* fields omitted */ }

🔬 This is a nightly-only experimental API. (pin #49150)

[−] Expand description

A pinned, heap allocated reference.

Methods

impl<T> PinBox<T>

[−]

pub fn new(data: T) -> PinBox<T>

[−]

🔬 This is a nightly-only experimental API. (pin #49150)

Allocate memory on the heap, move the data into it and pin it.

impl<T: ?Sized> PinBox<T>

[−]

pub fn as_pin<'a>(&'a mut self) -> Pin<'a, T>

[−]

🔬 This is a nightly-only experimental API. (pin #49150)

Get a pinned reference to the data in this PinBox.

pub unsafe fn get_mut<'a>(this: &'a mut PinBox<T>) -> &'a mut T

[−]

🔬 This is a nightly-only experimental API. (pin #49150)

Get a mutable reference to the data inside this PinBox.

This function is unsafe. Users must guarantee that the data is never moved out of this reference.

Important traits for Box<I>

impl<I: Iterator + ?Sized> Iterator for Box<I> type Item = I::Item;

pub unsafe fn unpin(this: PinBox<T>) -> Box<T>

[−]

🔬 This is a nightly-only experimental API. (pin #49150)

Convert this PinBox into an unpinned Box.

This function is unsafe. Users must guarantee that the data is never moved out of the box.

Trait Implementations

impl<T: ?Sized> From<Box<T>> for PinBox<T>

[+]

fn from(boxed: Box<T>) -> PinBox<T>

[−]

Performs the conversion.

impl<T: Unpin + ?Sized> From<PinBox<T>> for Box<T>

[+]

Important traits for Box<I>

impl<I: Iterator + ?Sized> Iterator for Box<I> type Item = I::Item;

fn from(pinned: PinBox<T>) -> Box<T>

[−]

Performs the conversion.

impl<T: ?Sized> Deref for PinBox<T>

[+]

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

[−]

Dereferences the value.

impl<T: Unpin + ?Sized> DerefMut for PinBox<T>

[+]

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

[−]

Mutably dereferences the value.

impl<T: Display + ?Sized> Display for PinBox<T>

[+]

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

[−]

Formats the value using the given formatter.

impl<T: Debug + ?Sized> Debug for PinBox<T>

[+]

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

[−]

Formats the value using the given formatter.

impl<T: ?Sized> Pointer for PinBox<T>

[+]

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

[−]

Formats the value using the given formatter.

impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<PinBox<U>> for PinBox<T>