Struct manually_boxed::TokenMut

pub struct TokenMut<'a>(/* private fields */);

&mut NoAliasSingleton, but zero-sized

See TokenRef

Implementations

impl<'a> TokenMut<'a>

pub unsafe fn new_unchecked() -> Self

Allows borrowing on the caller’s recognisance

This will let you call Ptr::borrow()/borrow_mut() multiple times, retaining and using all the resulting references.

For another approach, see Ptr::as_ptr().

SAFETY

The calls to borrow[_mut] that this enables must not violate Rust’s rules. Checking that is up to you.

So, all of the Ptr you borrow_mut must be distinct, and they must be distinct from your borrows. Violating this rule is instant undefined behaviour, even if you never read or write the resulting reference(s).

Also, it is up to you to make sure you don’t free the data to soon.

Trait Implementations

impl<'a> Debug for TokenMut<'a>

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

Formats the value using the given formatter.

impl<'a> IsTokenMut<'a> for TokenMut<'a>

fn token_mut<'r>(self) -> TokenMut<'r>

where 'a: 'r,

Obtains a new ZST token from something that might be a real object.

fn as_mut<'r, 's: 'r>(&'s mut self) -> TokenMut<'r>

where 'a: 'r,

Obtains a new ZST token from a borrow that might be of a real object.

fn multi_static<'r>(self) -> MultiStatic<'r, ()>

where 'a: 'r,

Borrows from a small, fixed, number of multiple Ptr

fn multi_dynamic<'r>(self) -> MultiDynamic<'r>

where 'a: 'r,

Borrows from an unknown number of Ptr with dynamic runtime checking

impl<'o, 'i: 'o, 'j: 'o> IsTokenMut<'o> for &'i mut TokenMut<'j>

fn token_mut<'r>(self) -> TokenMut<'r>

where 'a: 'r,

Obtains a new ZST token from something that might be a real object.

fn as_mut<'r, 's: 'r>(&'s mut self) -> TokenMut<'r>

where 'a: 'r,

Obtains a new ZST token from a borrow that might be of a real object.

fn multi_static<'r>(self) -> MultiStatic<'r, ()>

where 'a: 'r,

Borrows from a small, fixed, number of multiple Ptr

fn multi_dynamic<'r>(self) -> MultiDynamic<'r>

where 'a: 'r,

Borrows from an unknown number of Ptr with dynamic runtime checking

impl<'a> IsTokenRef<'a> for TokenMut<'a>

fn token_ref(self) -> TokenRef<'a>

Obtains a new ZST token from something that might be a real object.

impl<'o, 'i: 'o, 'j: 'o> IsTokenRef<'o> for &'i TokenMut<'j>

fn token_ref(self) -> TokenRef<'a>

Obtains a new ZST token from something that might be a real object.

impl<'o, 'i: 'o, 'j: 'o> IsTokenRef<'o> for &'i mut TokenMut<'j>

fn token_ref(self) -> TokenRef<'a>

Obtains a new ZST token from something that might be a real object.