Struct elysees::ArcHandle

#[repr(transparent)]pub struct ArcHandle<T: ?Sized> { /* fields omitted */ }

An atomically reference counted shared pointer

See the documentation for Arc in the standard library. Unlike the standard library Arc, ArcHandle does not support weak reference counting.

Implementations

impl<T> ArcHandle<T>

pub fn new(data: T) -> Self

Construct an ArcHandle<T>

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

Convert the ArcHandle<T> to a raw pointer, suitable for use across FFI

Note: This returns a pointer to the data T, which is offset in the allocation.

It is recommended to use Arc for this.

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

Reconstruct the ArcHandle<T> from a raw pointer obtained from into_raw()

Note: This raw pointer will be offset in the allocation and must be preceded by the atomic count.

It is recommended to use Arc for this

pub fn borrow_arc<'a>(&'a self) -> ArcBorrow<'a, T>

Produce a pointer to the data that can be converted back to an ArcHandle<T>. This is basically an &ArcHandle<T>, without the extra indirection. It has the benefits of an &T but also knows about the underlying refcount and can be converted into more ArcHandle<T>s if necessary.

pub fn with_arc<F, U>(&self, f: F) -> U where
    F: FnOnce(&Arc<T>) -> U, 

Temporarily converts |self| into a bonafide Arc and exposes it to the provided callback. The refcount is not modified.

pub fn heap_ptr(&self) -> *const c_void

Returns the address on the heap of the ArcHandle itself -- not the T within it -- for memory reporting.

pub fn into_arc(a: Self) -> Arc<T>

Converts an ArcHandle into a Arc. This consumes the ArcHandle, so the refcount is not modified.

pub fn from_arc(a: Arc<T>) -> Self

Converts a Arc into an ArcHandle. This consumes the Arc, so the refcount is not modified.

impl<T: ?Sized> ArcHandle<T>

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

Test pointer equality between the two Arcs, i.e. they must be the same allocation

impl<T: Clone> ArcHandle<T>

pub fn make_mut(this: &mut Self) -> &mut T

Makes a mutable reference to the ArcHandle, cloning if necessary

This is functionally equivalent to Arc::make_mut from the standard library.

If this ArcHandle is uniquely owned, make_mut() will provide a mutable reference to the contents. If not, make_mut() will create a new ArcHandle with a copy of the contents, update this to point to it, and provide a mutable reference to its contents.

This is useful for implementing copy-on-write schemes where you wish to avoid copying things if your Arc is not shared.

impl<T: ?Sized> ArcHandle<T>

pub fn get_mut(this: &mut Self) -> Option<&mut T>

Provides mutable access to the contents if the Arc is uniquely owned.

pub fn is_unique(&self) -> bool

Whether or not the Arc is uniquely owned (is the refcount 1?).

pub fn get_count(&self, ordering: LoadOrdering) -> usize

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

impl<H, T> ArcHandle<HeaderSlice<H, [T]>>

pub fn from_header_and_iter<I>(header: H, items: I) -> Self where
    I: Iterator<Item = T> + ExactSizeIterator, 

Creates an Arc for a HeaderSlice using the given header struct and iterator to generate the slice. The resulting Arc will be fat.

impl<H, T> ArcHandle<HeaderSlice<HeaderWithLength<H>, [T]>>

pub fn into_thin(a: Self) -> ThinArc<H, T>

Converts an ArcHandle into a ThinArc. This consumes the ArcHandle, so the refcount is not modified.

pub fn from_thin(a: ThinArc<H, T>) -> Self

Converts a ThinArc into an ArcHandle. This consumes the ThinArc, so the refcount is not modified.

Trait Implementations

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

fn as_ref(&self) -> &T

Performs the conversion.

impl<T: ?Sized> Borrow<T> for ArcHandle<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: ?Sized> Clone for ArcHandle<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> CloneStableDeref for ArcHandle<T>

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

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

Formats the value using the given formatter.

impl<T: Default> Default for ArcHandle<T>

fn default() -> ArcHandle<T>

Returns the "default value" for a type.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for ArcHandle<T>

fn deserialize<D>(deserializer: D) -> Result<ArcHandle<T>, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: ?Sized + Display> Display for ArcHandle<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Drop for ArcHandle<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized + Eq> Eq for ArcHandle<T>

impl<T> From<T> for ArcHandle<T>

fn from(t: T) -> Self

Performs the conversion.

impl<T: ?Sized + Hash> Hash for ArcHandle<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<T: ?Sized + Ord> Ord for ArcHandle<T>

fn cmp(&self, other: &ArcHandle<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<T: ?Sized + PartialEq> PartialEq<ArcHandle<T>> for ArcHandle<T>

fn eq(&self, other: &ArcHandle<T>) -> bool

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

fn ne(&self, other: &ArcHandle<T>) -> bool

This method tests for !=.

impl<T: ?Sized + PartialOrd> PartialOrd<ArcHandle<T>> for ArcHandle<T>

fn partial_cmp(&self, other: &ArcHandle<T>) -> Option<Ordering>

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

fn lt(&self, other: &ArcHandle<T>) -> bool

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

fn le(&self, other: &ArcHandle<T>) -> bool

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

fn gt(&self, other: &ArcHandle<T>) -> bool

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

fn ge(&self, other: &ArcHandle<T>) -> bool

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

impl<T: ?Sized> Pointer for ArcHandle<T>

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

Formats the value using the given formatter.

impl<T: ?Sized + Sync + Send> Send for ArcHandle<T>

impl<T: Serialize> Serialize for ArcHandle<T>

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

Serialize this value into the given Serde serializer.

impl<T: ?Sized> StableDeref for ArcHandle<T>

impl<T: ?Sized + Sync + Send> Sync for ArcHandle<T>