Struct deborrow::Reference

pub struct Reference<'a, T: ?Sized, const IS_MUT: bool> { /* private fields */ }

A reference which can be shared between threads and converted back into normal refs anywhere.

Implementations

impl<'a, T: ?Sized> Reference<'a, T, false>

pub fn from_ref(r: &'a T) -> Self

Constructs a Reference from a non-mutable reference

impl<'a, T: ?Sized> Reference<'a, T, true>

pub fn from_mut(r: &'a mut T) -> Self

Constructs a Reference from a mutable reference

pub unsafe fn as_mut(&self) -> Option<&'a mut T>

Turns the Reference into a mutable ref if it has been created from a mutable ref.

impl<'a, T: ?Sized, const IS_MUT: bool> Reference<'a, T, IS_MUT>

pub unsafe fn as_ref(&self) -> &'a T

Turns the Reference into a non-mutable ref.

SAFETY:

This function is only safe until the reference has been “polluted” by a call to any as_mut.

pub unsafe fn mutable(&self) -> Reference<'a, T, true>

Turns the Reference into a mutable ref even if it has been created from a non-mutable ref.

pub unsafe fn disconnect<'b>(&self) -> Reference<'b, T, IS_MUT>

Deborrows the Reference, returning a new one with a disconnected lifetime.

Trait Implementations

impl<'a, T: Clone + ?Sized, const IS_MUT: bool> Clone for Reference<'a, T, IS_MUT>

fn clone(&self) -> Reference<'a, T, IS_MUT>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T: Debug + ?Sized, const IS_MUT: bool> Debug for Reference<'a, T, IS_MUT>

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

Formats the value using the given formatter.

impl<'a, T: PartialEq + ?Sized, const IS_MUT: bool> PartialEq for Reference<'a, T, IS_MUT>

fn eq(&self, other: &Reference<'a, T, IS_MUT>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T: Copy + ?Sized, const IS_MUT: bool> Copy for Reference<'a, T, IS_MUT>

impl<'a, T: Eq + ?Sized, const IS_MUT: bool> Eq for Reference<'a, T, IS_MUT>

impl<'a, T: ?Sized, const IS_MUT: bool> Send for Reference<'a, T, IS_MUT>

impl<'a, T: ?Sized, const IS_MUT: bool> StructuralEq for Reference<'a, T, IS_MUT>

impl<'a, T: ?Sized, const IS_MUT: bool> StructuralPartialEq for Reference<'a, T, IS_MUT>

impl<'a, T: ?Sized, const IS_MUT: bool> Sync for Reference<'a, T, IS_MUT>