Struct elysees::ArcBorrow

#[repr(transparent)]pub struct ArcBorrow<'a, T: ?Sized + 'a>(_);

A "borrowed Arc". This is a pointer to a T that is known to have been allocated within an Arc.

This is equivalent in guarantees to &ArcHandle<T>, however it is a bit more flexible. To obtain an &ArcHandle<T> you must have an ArcHandle<T> instance somewhere pinned down until we're done with it. It's also a direct pointer to T, so using this involves less pointer-chasing

However, C++ code may hand us refcounted things as pointers to T directly, so we have to conjure up a temporary Arc on the stack each time. The same happens for when the object is managed by a Arc.

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(&self) -> Arc<T>

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

pub fn as_arc(&self) -> &Arc<T>

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

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

For constructing from a reference known to be Arc-backed, e.g. if we obtain such a reference over FFI

Safety

The reference passed in must be to a T within a valid ArcInner. Valid examples include the result of ArcBorrow::get, Arc::deref, etc. The reference passed in may not be from a T owned by an ArcBox, as this violates the ArcBox's uniqueness guarantees.

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 count(this: ArcBorrow<'a, T>, ordering: Ordering) -> usize

Get the reference count of this Arc with a given memory ordering

Trait Implementations

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

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

Performs the conversion.

impl<'a, T: ?Sized> AsRef<*const T> for ArcBorrow<'a, T>

fn as_ref(&self) -> &*const T

Performs the conversion.

impl<'a, T: ?Sized> AsRef<*mut T> for ArcBorrow<'a, T>

fn as_ref(&self) -> &*mut T

Performs the conversion.

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

fn as_ref(&self) -> &Arc<T>

Performs the conversion.

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

fn as_ref(&self) -> &NonNull<T>

Performs the conversion.

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

fn as_ref(&self) -> &T

Performs the conversion.

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

fn borrow(&self) -> &&'a T

Immutably borrows from an owned value.

impl<'a, T: ?Sized> Borrow<*const T> for ArcBorrow<'a, T>

fn borrow(&self) -> &*const T

Immutably borrows from an owned value.

impl<'a, T: ?Sized> Borrow<*mut T> for ArcBorrow<'a, T>

fn borrow(&self) -> &*mut T

Immutably borrows from an owned value.

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

fn borrow(&self) -> &Arc<T>

Immutably borrows from an owned value.

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

fn borrow(&self) -> &NonNull<T>

Immutably borrows from an owned value.

impl<'a, T: ?Sized> Borrow<T> for ArcBorrow<'a, 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 copy of the value.

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

Performs copy-assignment from source.

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

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

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

impl<'a, T: ?Sized + Erasable> ErasablePtr for ArcBorrow<'a, 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<'a, T: Hash + ?Sized + 'a> Hash for ArcBorrow<'a, 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, 

Feeds a slice of this type into the given [Hasher].

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

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

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

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

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

impl<'a, T: ?Sized> UnionAlign for ArcBorrow<'a, T> where
    ArcBorrow<'a, T>: ErasablePtr, 

fn left<B: UnionAlign>(this: Self) -> Union2<Self, B>

fn right<A: UnionAlign>(this: Self) -> Union2<A, Self>

fn a<B: UnionAlign, C: UnionAlign, D: UnionAlign>(
    this: Self
) -> Union4<Self, B, C, D>

fn b<A: UnionAlign, C: UnionAlign, D: UnionAlign>(
    this: Self
) -> Union4<A, Self, C, D>

fn c<A: UnionAlign, B: UnionAlign, D: UnionAlign>(
    this: Self
) -> Union4<A, B, Self, D>

fn d<A: UnionAlign, B: UnionAlign, C: UnionAlign>(
    this: Self
) -> Union4<A, B, C, Self>