Trait Well 

pub unsafe trait Well {
    type Target;

    // Required methods
    unsafe fn insert(ptr: NonNull<Self::Target>) -> Self;
    fn remove(self) -> NonNull<Self::Target>;
}

Smart pointer.

Safety

Types that implement this trait assert that the insert and remove methods are true inverses of each other with no side effects.

Required Associated Types

type Target

Data stored in the pointer.

Required Methods

unsafe fn insert(ptr: NonNull<Self::Target>) -> Self

Put the data back into the well.

Safety

The pointer passed to insert must previously have been received from remove.

fn remove(self) -> NonNull<Self::Target>

Take the data out of the well.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<'w, T> Well for &'w T

type Target = T

unsafe fn insert(ptr: NonNull<T>) -> &'w T

fn remove(self) -> NonNull<T>

impl<T> Well for &mut T

type Target = T

unsafe fn insert(ptr: NonNull<T>) -> Self

fn remove(self) -> NonNull<T>

impl<T> Well for Box<T>

Available on crate features alloc only.

type Target = T

unsafe fn insert(ptr: NonNull<T>) -> Self

fn remove(self) -> NonNull<T>

impl<T> Well for Rc<T>

Available on crate feature alloc only.

type Target = T

unsafe fn insert(ptr: NonNull<T>) -> Self

fn remove(self) -> NonNull<T>

impl<T> Well for Weak<T>

Available on crate feature alloc only.

type Target = T

unsafe fn insert(ptr: NonNull<T>) -> Self

fn remove(self) -> NonNull<T>

impl<T> Well for Arc<T>

Available on crate features alloc only.

type Target = T

unsafe fn insert(ptr: NonNull<T>) -> Self

fn remove(self) -> NonNull<T>

impl<T> Well for Weak<T>

Available on crate features alloc only.

type Target = T

unsafe fn insert(ptr: NonNull<T>) -> Self

fn remove(self) -> NonNull<T>

impl<W: StrongWell> Well for Pin<W>

type Target = <W as Well>::Target

unsafe fn insert(ptr: NonNull<Target<W>>) -> Pin<W>

fn remove(self) -> NonNull<Target<W>>

Implementors