UnsafePinned in core::pin - Rust
Skip to main content UnsafePinned core :: pin Struct Unsafe Pinned Source pub struct UnsafePinned<T: ? Sized > { /* private fields */ } 🔬 This is a nightly-only experimental API. ( unsafe_pinned #125735 ) Expand description 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 § Source § impl<T> UnsafePinned <T> Source pub const fn new (value: T) -> Self 🔬 This is a nightly-only experimental API. ( unsafe_pinned #125735 ) 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. Source pub const fn into_inner (self) -> T 🔬 This is a nightly-only experimental API. ( unsafe_pinned #125735 ) Unwraps the value, consuming this UnsafePinned . Source § impl<T: ? Sized > UnsafePinned <T> Source pub const fn get_mut_pinned (self: Pin <&mut Self>) -> *mut T 🔬 This is a nightly-only experimental API. ( unsafe_pinned #125735 ) Get read-write access to the contents of a pinned UnsafePinned .
Source pub const fn get_mut_unchecked (&mut self) -> *mut T 🔬 This is a nightly-only experimental API. ( unsafe_pinned #125735 ) 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. Source pub const fn get (&self) -> *mut T 🔬 This is a nightly-only experimental API. ( unsafe_pinned #125735 ) 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 ); } Source pub const fn raw_get (this: *const Self) -> *mut T 🔬 This is a nightly-only experimental API. ( unsafe_pinned #125735 ) 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. Source pub const fn raw_get_mut (this: *mut Self) -> *mut T 🔬 This is a nightly-only experimental API. ( unsafe_pinned #125735 ) 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.
Trait Implementations § Source § impl<T: ? Sized > ! Unpin for UnsafePinned <T> When this type is used, that almost certainly means safe APIs need to use pinning to avoid the aliases from becoming invalidated. Therefore let’s mark this as !Unpin . You can always opt back in to Unpin with an impl block, provided your API is still sound while unpinned. Source § impl<T: PointeeSized > ! UnsafeUnpin for UnsafePinned <T> Source § impl<T: CoerceUnsized <U>, U> CoerceUnsized < UnsafePinned <U>> for UnsafePinned <T> Source § impl<T: ?
Sized > Debug for UnsafePinned <T> Source § fn fmt (&self, f: &mut Formatter <'_>) -> Result Formats the value using the given formatter. Read more Source § impl<T: Default > Default for UnsafePinned <T> Source § fn default () -> Self Creates an UnsafePinned , with the Default value for T. Source § impl<T: DispatchFromDyn <U>, U> DispatchFromDyn < UnsafePinned <U>> for UnsafePinned <T> Source § impl<T> From <T> for UnsafePinned <T> Source § fn from (value: T) -> Self Creates a new UnsafePinned<T> containing the given value.
Source § impl<T: ? Sized + Sync > Sync for UnsafePinned <T> Auto Trait Implementations § § impl<T> ! Freeze for UnsafePinned <T> § impl<T> ! RefUnwindSafe for UnsafePinned <T> § impl<T> Send for UnsafePinned <T> where T: Send + ? Sized , § impl<T> UnwindSafe for UnsafePinned <T> where T: UnwindSafe + ? Sized , Blanket Implementations § Source § impl<T> Any for T where T: 'static + ? Sized , Source § fn type_id (&self) -> TypeId Gets the TypeId of self .
Read more Source § impl<T> Borrow <T> for T where T: ? Sized , Source § fn borrow (&self) -> &T Immutably borrows from an owned value. Read more Source § impl<T> BorrowMut <T> for T where T: ? Sized , Source § fn borrow_mut (&mut self) -> &mut T Mutably borrows from an owned value. Read more Source § impl<T> From <T> for T Source § fn from (t: T) -> T Returns the argument unchanged. Source § impl<T, U> Into <U> for T where U: From <T>, Source § fn into (self) -> U Calls U::from(self) .
That is, this conversion is whatever the implementation of From <T> for U chooses to do. Source § impl<T, U> TryFrom <U> for T where U: Into <T>, Source § type Error = ! The type returned in the event of a conversion error. Source § fn try_from (value: U) -> Result <T, ! > Performs the conversion. Source § impl<T, U> TryInto <U> for T where U: TryFrom <T>, Source § type Error = <U as TryFrom <T>>:: Error The type returned in the event of a conversion error.
Source § fn try_into (self) -> Result <U, <U as TryFrom <T>>:: Error > Performs the conversion.