Struct UnsafePinned

struct UnsafePinned<T: ?Sized> { ... }

This type provides a way to entirely opt-out of typical aliasing rules; specifically, &mut UnsafePinned<T> is not guaranteed to be a unique pointer. This also subsumes the effects of UnsafeCell, i.e., &UnsafePinned<T> may point to data that is being mutated.

However, even if you define your type like pub struct Wrapper(UnsafePinned<...>), it is still very risky to have an &mut Wrapper that aliases anything else. Many functions that work generically on &mut T assume that the memory that stores T is uniquely owned (such as mem::swap). In other words, while having aliasing with &mut Wrapper is not immediate Undefined Behavior, it is still unsound to expose such a mutable reference to code you do not control! Techniques such as pinning via Pin are needed to ensure soundness.

Similar to UnsafeCell, UnsafePinned will not usually show up in the public API of a library. It is an internal implementation detail of libraries that need to support aliasing mutable references.

This type blocks niches the same way UnsafeCell does.

Implementations

impl<T> UnsafePinned<T>

const fn new(value: T) -> Self

Constructs a new instance of UnsafePinned which will wrap the specified value.

All access to the inner value through &UnsafePinned<T> or &mut UnsafePinned<T> or Pin<&mut UnsafePinned<T>> requires unsafe code.

const fn into_inner(self: Self) -> T

Unwraps the value, consuming this UnsafePinned.

impl<T: ?Sized> UnsafePinned<T>

const fn get_mut_pinned(self: Pin<&mut Self>) -> *mut T

Get read-write access to the contents of a pinned UnsafePinned.

const fn get_mut_unchecked(self: &mut Self) -> *mut T

Get read-write access to the contents of an UnsafePinned.

You should usually be using get_mut_pinned instead to explicitly track the fact that this memory is "pinned" due to there being aliases.

const fn get(self: &Self) -> *mut T

Get mutable access to the contents of a shared UnsafePinned.

This can be cast to a pointer of any kind. When creating references, you must uphold the aliasing rules; see UnsafeCell for more discussion and caveats.

#![feature(unsafe_pinned)]
use std::pin::UnsafePinned;

unsafe {
    let mut x = UnsafePinned::new(0);
    let ptr = x.get();
    x.get_mut_unchecked().write(1);
    assert_eq!(ptr.read(), 1);
}

const fn raw_get(this: *const Self) -> *mut T

Gets an immutable pointer to the wrapped value.

The difference from get is that this function accepts a raw pointer, which is useful to avoid the creation of temporary references.

const fn raw_get_mut(this: *mut Self) -> *mut T

Gets a mutable pointer to the wrapped value.

The difference from get_mut_pinned and get_mut_unchecked is that this function accepts a raw pointer, which is useful to avoid the creation of temporary references.

impl<T> Any for UnsafePinned<T>

fn type_id(self: &Self) -> TypeId

impl<T> Borrow for UnsafePinned<T>

fn borrow(self: &Self) -> &T

impl<T> BorrowMut for UnsafePinned<T>

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

impl<T> Freeze for UnsafePinned<T>

impl<T> From for UnsafePinned<T>

fn from(value: T) -> Self

Creates a new UnsafePinned<T> containing the given value.

impl<T> From for UnsafePinned<T>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> From for UnsafePinned<T>

fn from(t: never) -> T

impl<T> RefUnwindSafe for UnsafePinned<T>

impl<T> Send for UnsafePinned<T>

impl<T> UnwindSafe for UnsafePinned<T>

impl<T, U> Into for UnsafePinned<T>

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom for UnsafePinned<T>

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto for UnsafePinned<T>

fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T: ?Sized + Sync> Sync for UnsafePinned<T>

impl<T: ?Sized> Debug for UnsafePinned<T>

fn fmt(self: &Self, f: &mut Formatter<'_>) -> Result

impl<T: ?Sized> Unpin for UnsafePinned<T>

impl<T: ?Sized> UnsafeUnpin for UnsafePinned<T>

impl<T: CoerceUnsized<U>, U> CoerceUnsized for UnsafePinned<T>

impl<T: Default> Default for UnsafePinned<T>

fn default() -> Self

Creates an UnsafePinned, with the Default value for T.

impl<T: DispatchFromDyn<U>, U> DispatchFromDyn for UnsafePinned<T>