Struct nom::lib::std::boxed::PinBox

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

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

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)

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

impl<T> PinBox<T> where     T: ?Sized,

pub fn as_pin_mut(&'a mut self) -> PinMut<'a, T>

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

Get a pinned reference to the data in this PinBox.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

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<R>

impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

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> DerefMut for PinBox<T> where     T: Unpin + ?Sized,

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Mutably dereferences the value.

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

type Target = T

The resulting type after dereferencing.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref(&self) -> &T

Dereferences the value.

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

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

Formats the value using the given formatter.

impl<T> Unpin for PinBox<T> where     T: ?Sized,

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Important traits for Box<R>

impl<R> Read for Box<R> where
    R: Read + ?Sized, impl<W> Write for Box<W> where
    W: Write + ?Sized, impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Performs the conversion.

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

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

Performs the conversion.