Struct RefToken

pub struct RefToken<T: ?Sized>(/* private fields */);

Abstraction of a reference as a token.

The reference should point to a pinned object, otherwise moving the object will “invalidate” the cells initialized with the previous reference.

Implementations

impl<T: ?Sized> RefToken<T>

pub fn from_ref(t: &T) -> &Self

where T: Unpin,

Convert an immutable reference into an immutable RefToken reference.

pub fn from_mut(t: &mut T) -> &mut Self

where T: Unpin,

Convert a mutable reference into a mutable RefToken reference.

pub fn from_pin(t: Pin<&T>) -> &Self

Convert a pinned immutable reference into an immutable RefToken reference.

pub fn from_pin_mut(t: Pin<&mut T>) -> &mut Self

Convert a pinned mutable reference into a mutable RefToken reference.

pub fn as_pin(&self) -> Pin<&T>

Get a pinned immutable reference.

pub fn as_pin_mut(&mut self) -> Pin<&mut T>

Get a pinned mutable reference.

Trait Implementations

impl<T: Unpin + ?Sized> AsMut<T> for RefToken<T>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: ?Sized> AsRef<T> for RefToken<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Debug + ?Sized> Debug for RefToken<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for RefToken<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Unpin + ?Sized> DerefMut for RefToken<T>

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

Mutably dereferences the value.

impl<'a, T: Unpin + ?Sized> From<&'a T> for &'a RefToken<T>

fn from(value: &'a T) -> Self

Converts to this type from the input type.

impl<'a, T: Unpin + ?Sized> From<&'a mut T> for &'a mut RefToken<T>

fn from(value: &'a mut T) -> Self

Converts to this type from the input type.

impl<'a, T: ?Sized> From<Pin<&'a T>> for &'a RefToken<T>

fn from(value: Pin<&'a T>) -> Self

Converts to this type from the input type.

impl<'a, T: ?Sized> From<Pin<&'a mut T>> for &'a mut RefToken<T>

fn from(value: Pin<&'a mut T>) -> Self

Converts to this type from the input type.

impl<T: ?Sized> Token for RefToken<T>

type Id = PtrId<T>

Id of the token.

fn id(&self) -> Self::Id

Returns the token id.

fn is_unique(&mut self) -> bool

Returns true if the token is “unique”, see safety