Struct situ::Mut

pub struct Mut<'a, T: ?Sized> { /* private fields */ }

An immovable mutable reference, like &mut T that cannot be relocated.

Implementations

impl<'a, T: ?Sized> Mut<'a, T>

pub unsafe fn new_unchecked(ptr: *mut T) -> Self

Creates a new Mut from an exclusively borrowed pointer.

Safety

• ptr must be non-null, properly aligned, and valid for reads and writes.
• ptr must not alias any other accessible references for 'a.
• The value pointed to by ptr must be initialized and immovable.

pub unsafe fn map_unchecked<F, U>(self, f: F) -> Mut<'a, U>where
    F: FnOnce(*mut T) -> *mut U,

Constructs a new Mut by mapping the interior pointer.

Safety

• The pointer returned by f must be non-null, properly aligned, and valid for reads and writes.
• The pointer returned by f must not alias any other accessible references for 'a.
• The value pointed to by the pointer returned by f must be initialized and immutable.

pub fn as_ptr(&self) -> *mut T

Returns a pointer to the referenced value.

pub fn as_non_null(&self) -> NonNull<T>

Returns a NonNull to the referenced value.

pub fn as_ref(&self) -> Ref<'_, T>

Returns a Ref of the referenced value.

pub fn as_mut(&mut self) -> Mut<'_, T>

Returns a reborrowed Mut of the referenced value.

pub unsafe fn take(self) -> Val<'a, T>where
    T: DropRaw,

Assumes ownership of the value in the Mut.

Safety

• The value pointed to by the Mut must be valid for dropping.
• The caller must ensure that the value pointed to by the Mut is never accessed in an illegal state. Because Val may drop the value, care must be taken to forget the Val or replace the value after dropping it.

Trait Implementations

impl<T: DebugRaw + ?Sized> Debug for Mut<'_, T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for Mut<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Unpin + ?Sized> DerefMut for Mut<'_, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T: ?Sized> Destructure for Mut<'a, T>

type Underlying = T

The underlying type that is destructured.

type Destructuring = Ref

The type of destructuring to perform.

fn underlying(&mut self) -> *mut Self::Underlying

Returns a mutable pointer to the underlying type.

impl<T: DisplayRaw + ?Sized> Display for Mut<'_, T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Pointer for Mut<'_, T>

type Target = T

The target value of this type.

fn target(&self) -> *mut Self::Target

Returns a pointer to this type’s target.

impl<'a, T, U: 'a> Restructure<U> for Mut<'a, T>

type Restructured = Mut<'a, U>

The restructured version of this type.

unsafe fn restructure(&self, ptr: *mut U) -> Self::Restructured

Restructures a pointer to this type into the target type.

impl<T: ?Sized> RestructurablePointer for Mut<'_, T>

impl<T: Unique + ?Sized> Unique for Mut<'_, T>

impl<T: Pinned<R> + ?Sized, R: Region> Within<R> for Mut<'_, T>