[−][src]Struct std::pin::PinBox
A pinned, heap allocated reference.
This type is similar to Box
, except that it pins its value,
which prevents it from moving out of the reference, unless it implements Unpin
.
See the module documentation for furthur explaination on pinning.
Methods
impl<T> PinBox<T>
[src]
impl<T> PinBox<T>
impl<T> PinBox<T> where
T: ?Sized,
[src]
impl<T> PinBox<T> where
T: ?Sized,
pub fn as_pin_mut(&'a mut self) -> PinMut<'a, T>
[src]
pub fn as_pin_mut(&'a mut self) -> PinMut<'a, T>
Get a pinned reference to the data in this PinBox.
pub unsafe fn from_raw(raw: *mut T) -> PinBox<T>
[src]
pub unsafe fn from_raw(raw: *mut T) -> PinBox<T>
Constructs a PinBox
from a raw pointer.
After calling this function, the raw pointer is owned by the
resulting PinBox
. Specifically, the PinBox
destructor will call
the destructor of T
and free the allocated memory. Since the
way PinBox
allocates and releases memory is unspecified, the
only valid pointer to pass to this function is the one taken
from another PinBox
via the PinBox::into_raw
function.
This function is unsafe because improper use may lead to memory problems. For example, a double-free may occur if the function is called twice on the same raw pointer.
Examples
#![feature(pin)] use std::pin::PinBox; let x = PinBox::new(5); let ptr = PinBox::into_raw(x); let x = unsafe { PinBox::from_raw(ptr) };Run
pub fn into_raw(b: PinBox<T>) -> *mut T
[src]
pub fn into_raw(b: PinBox<T>) -> *mut T
Consumes the PinBox
, returning the wrapped raw pointer.
After calling this function, the caller is responsible for the
memory previously managed by the PinBox
. In particular, the
caller should properly destroy T
and release the memory. The
proper way to do so is to convert the raw pointer back into a
PinBox
with the PinBox::from_raw
function.
Note: this is an associated function, which means that you have
to call it as PinBox::into_raw(b)
instead of b.into_raw()
. This
is so that there is no conflict with a method on the inner type.
Examples
#![feature(pin)] use std::pin::PinBox; let x = PinBox::new(5); let ptr = PinBox::into_raw(x);Run
ⓘImportant traits for &'a mut Ipub unsafe fn get_mut(this: &'a mut PinBox<T>) -> &'a mut T
[src]
pub unsafe fn get_mut(this: &'a mut PinBox<T>) -> &'a mut T
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>pub unsafe fn unpin(this: PinBox<T>) -> Box<T>
[src]
pub unsafe fn unpin(this: PinBox<T>) -> Box<T>
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<'a, T, F> UnsafeFutureObj<'a, T> for PinBox<F> where
F: Future<Output = T> + 'a,
[src]
impl<'a, T, F> UnsafeFutureObj<'a, T> for PinBox<F> where
F: Future<Output = T> + 'a,
fn into_raw(self) -> *mut ()
[src]
fn into_raw(self) -> *mut ()
🔬 This is a nightly-only experimental API. (futures_api
#50547)
futures in libcore are unstable
Convert an owned instance into a (conceptually owned) void pointer.
unsafe fn poll(ptr: *mut (), cx: &mut Context) -> Poll<T>
[src]
unsafe fn poll(ptr: *mut (), cx: &mut Context) -> Poll<T>
🔬 This is a nightly-only experimental API. (futures_api
#50547)
futures in libcore are unstable
Poll the future represented by the given void pointer. Read more
unsafe fn drop(ptr: *mut ())
[src]
unsafe fn drop(ptr: *mut ())
🔬 This is a nightly-only experimental API. (futures_api
#50547)
futures in libcore are unstable
Drops the future represented by the given void pointer. Read more
impl<T> Deref for PinBox<T> where
T: ?Sized,
[src]
impl<T> Deref for PinBox<T> where
T: ?Sized,
type Target = T
The resulting type after dereferencing.
ⓘImportant traits for &'a mut Ifn deref(&self) -> &T
[src]
fn deref(&self) -> &T
Dereferences the value.
impl<T> DerefMut for PinBox<T> where
T: Unpin + ?Sized,
[src]
impl<T> DerefMut for PinBox<T> where
T: Unpin + ?Sized,
ⓘImportant traits for &'a mut Ifn deref_mut(&mut self) -> &mut T
[src]
fn deref_mut(&mut self) -> &mut T
Mutably dereferences the value.
impl<T> Unpin for PinBox<T> where
T: ?Sized,
[src]
impl<T> Unpin for PinBox<T> where
T: ?Sized,
impl<T> Display for PinBox<T> where
T: Display + ?Sized,
[src]
impl<T> Display for PinBox<T> where
T: Display + ?Sized,
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl<'a, F> From<PinBox<F>> for FutureObj<'a, ()> where
F: 'a + Send + Future<Output = ()>,
[src]
impl<'a, F> From<PinBox<F>> for FutureObj<'a, ()> where
F: 'a + Send + Future<Output = ()>,
impl<T> From<Box<T>> for PinBox<T> where
T: ?Sized,
[src]
impl<T> From<Box<T>> for PinBox<T> where
T: ?Sized,
impl<T> From<PinBox<T>> for Box<T> where
T: Unpin + ?Sized,
[src]
impl<T> From<PinBox<T>> for Box<T> where
T: Unpin + ?Sized,
impl<'a, F> From<PinBox<F>> for LocalFutureObj<'a, ()> where
F: 'a + Future<Output = ()>,
[src]
impl<'a, F> From<PinBox<F>> for LocalFutureObj<'a, ()> where
F: 'a + Future<Output = ()>,
fn from(boxed: PinBox<F>) -> LocalFutureObj<'a, ()>
[src]
fn from(boxed: PinBox<F>) -> LocalFutureObj<'a, ()>
Performs the conversion.
impl<F> Future for PinBox<F> where
F: Future + ?Sized,
[src]
impl<F> Future for PinBox<F> where
F: Future + ?Sized,
type Output = <F as Future>::Output
🔬 This is a nightly-only experimental API. (futures_api
#50547)
futures in libcore are unstable
The result of the Future
.
fn poll(
self: PinMut<PinBox<F>>,
cx: &mut Context
) -> Poll<<PinBox<F> as Future>::Output>
[src]
fn poll(
self: PinMut<PinBox<F>>,
cx: &mut Context
) -> Poll<<PinBox<F> as Future>::Output>
🔬 This is a nightly-only experimental API. (futures_api
#50547)
futures in libcore are unstable
Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more
impl<T> Debug for PinBox<T> where
T: Debug + ?Sized,
[src]
impl<T> Debug for PinBox<T> where
T: Debug + ?Sized,
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl<T, U> CoerceUnsized<PinBox<U>> for PinBox<T> where
T: Unsize<U> + ?Sized,
U: ?Sized,
[src]
impl<T, U> CoerceUnsized<PinBox<U>> for PinBox<T> where
T: Unsize<U> + ?Sized,
U: ?Sized,
impl<T> Pointer for PinBox<T> where
T: ?Sized,
[src]
impl<T> Pointer for PinBox<T> where
T: ?Sized,
Auto Trait Implementations
Blanket Implementations
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
ⓘImportant traits for &'a mut Ifn borrow(&self) -> &T
[src]
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
ⓘImportant traits for &'a mut Ifn borrow_mut(&mut self) -> &mut T
[src]
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
🔬 This is a nightly-only experimental API. (get_type_id
#27745)
this method will likely be replaced by an associated static
Gets the TypeId
of self
. Read more
impl<T> ToString for T where
T: Display + ?Sized,
[src]
impl<T> ToString for T where
T: Display + ?Sized,