Struct situ::Val

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

An immovable owned value in borrowed backing memory.

Implementations

impl<'a, T: DropRaw + ?Sized> Val<'a, T>

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

Creates a new Val from an exclusively owned pointer.

Safety

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

pub unsafe fn from_slot_unchecked(slot: Slot<'a, T>) -> Self

Creates a new Val from an initialized Slot.

Safety

The value pointed to by slot must be initialized, valid for dropping, and immovable.

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

Returns a pointer to the referenced value.

pub fn leak(v: Self) -> Mut<'a, T>

Consumes the Val and leaks its value, returning a mutable reference &'a mut T.

This function is mainly useful for data that lives for as long as its backing memory. Dropping the returned reference will cause a memory leak. If this is not acceptable, then the reference should first be wrapped with the Val::new_unchecked function, producing a Val. This Val can then be dropped which will properly destroy T.

Note: this is an associated function, which means that you have to call it as Val::leak(x) instead of x.leak(). This is so that there is no conflict with a method named leak on the value type.

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

Casts a Val<T> to a Val<U>.

Safety

The value owned by self must be a valid U.

pub fn read(this: Self) -> Twhere
    T: Sized + Unpin,

Consumes the Val and returns the value it contained.

Note: this is an associated function, which means that you have to call it as Val::read(this) instead of this.read(). This is so that there is no conflict with a method on the inner type.

pub fn read_unsized(this: Self, slot: Slot<'_, T>)where
    T: Pointee + Unpin,
    <T as Pointee>::Metadata: Metadata<T>,

Consumes the Val and moves it into the given Slot.

Note: this is an associated function, which means that you have to call it as Val::read_unsized(this, slot) instead of this.read_unsized(slot). This is so that there is no conflict with a method on the inner type.

Panics

Panics if slot does not have the same metadata as this.

pub unsafe fn read_unsized_unchecked(this: Self, slot: Slot<'_, T>)where
    T: Pointee + Unpin,
    <T as Pointee>::Metadata: Metadata<T>,

Consumes the Val and moves it into the given Slot.

Note: this is an associated function, which means that you have to call it as Val::read_unsized_unchecked(this, slot) instead of this.read_unsized_unchecked(slot). This is so that there is no conflict with a method on the inner type.

Safety

slot must have the same metadata as this.

pub fn forget(this: Self) -> Slot<'a, T>

Forgets the contained value, returning a Slot of the underlying memory.

pub fn drop(this: Self) -> Slot<'a, T>

Drops the contained value, returning a Slot of the underlying memory.

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.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T: DropRaw + ?Sized> Deref for Val<'_, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.

impl<'a, T: DropRaw + ?Sized> Destructure for Val<'a, T>

type Underlying = T

The underlying type that is destructured.

type Destructuring = Value

The type of destructuring to perform.

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

Returns a mutable pointer to the underlying type.

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

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

Formats the value using the given formatter.

impl<T: DropRaw + ?Sized> Drop for Val<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: DropRaw + ?Sized> Pointer for Val<'_, 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: DropRaw, U: 'a + DropRaw> Restructure<U> for Val<'a, T>

type Restructured = Val<'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: DropRaw + ?Sized> RestructurablePointer for Val<'_, T>

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

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