Struct ArcBorrow 

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

A “borrowed Arc”. This is essentially a reference to an ArcInner<T>

This is equivalent in guarantees to &Arc<T>, however it has the same representation as an Arc<T>, minimizing pointer-chasing.

ArcBorrow lets us deal with borrows of known-refcounted objects without needing to worry about where the Arc<T> is.

Implementations

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

pub fn clone_arc(this: Self) -> Arc<T>

Clone this as an Arc<T>. This bumps the refcount.

pub fn ptr_eq(this: Self, other: Self) -> bool

Compare two ArcBorrows via pointer equality. Will only return true if they come from the same allocation

pub fn get(&self) -> &'a T

Similar to deref, but uses the lifetime 'a rather than the lifetime of self, which is incompatible with the signature of the Deref trait.

pub fn as_arc(this: &Self) -> &Arc<T>

Borrow this as an Arc. This does not bump the refcount.

pub fn into_raw(this: Self) -> *const T

Get the internal pointer of an ArcBorrow

pub unsafe fn from_raw(raw: *const T) -> Self

Construct an ArcBorrow from an internal pointer

Safety

This pointer must be the result of ArcBorrow::from_raw or Arc::from_raw. In the latter case, the reference count is not incremented.

pub fn count(this: Self) -> usize

Gets the number of Arc pointers to this allocation

pub fn load_count(this: Self, order: Ordering) -> usize

Gets the number of Arc pointers to this allocation, with a given load ordering

pub fn heap_ptr(self) -> *const c_void

Returns the address on the heap of the ArcRef itself – not the T within it – for memory reporting.

impl<'a, T> ArcBorrow<'a, T>

pub fn as_arc_ref(this: &'a ArcBorrow<'a, T>) -> &'a ArcRef<'a, T>

Borrow this as an ArcRef. This does not bump the refcount.

Trait Implementations

impl<T> AsRef<T> for ArcBorrow<'_, T>

fn as_ref(&self) -> &T

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

impl<T> Borrow<T> for ArcBorrow<'_, T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<'a, T: ?Sized> Clone for ArcBorrow<'a, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for ArcBorrow<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> Deref for ArcBorrow<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T: Display> Display for ArcBorrow<'a, T>

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

Formats the value using the given formatter.

impl<T: ?Sized + Erasable> ErasablePtr for ArcBorrow<'_, T>

fn erase(this: Self) -> ErasedPtr

Turn this erasable pointer into an erased pointer.

unsafe fn unerase(this: ErasedPtr) -> Self

Unerase this erased pointer.

impl<T: Hash> Hash for ArcBorrow<'_, T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T: Ord> Ord for ArcBorrow<'a, T>

fn cmp(&self, other: &ArcBorrow<'a, T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a, 'b, T, U: PartialEq<T>> PartialEq<ArcBorrow<'a, T>> for ArcBorrow<'b, U>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ArcBorrow<'a, T>) -> bool

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

impl<'a, 'b, T, U: PartialOrd<T>> PartialOrd<ArcBorrow<'a, T>> for ArcBorrow<'b, U>

fn partial_cmp(&self, other: &ArcBorrow<'a, T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ArcBorrow<'a, T>) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ArcBorrow<'a, T>) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ArcBorrow<'a, T>) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ArcBorrow<'a, T>) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, T: ?Sized> Copy for ArcBorrow<'a, T>

impl<'a, T: Eq> Eq for ArcBorrow<'a, T>