Struct tiptoe::Arc

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

An asynchronously reference-counted smart pointer (copy-on-write single-item container).

Unlike with alloc::sync::Arc, the reference-count must be embedded in the payload instance itself.

Implementations

impl<T: ?Sized + IntrusivelyCountable> Arc<T>

pub fn new(value: T) -> Self where
    T: Sized, 

Creates a new instance of Arc<_> by moving value into a new heap allocation.

This increases the intrusive reference-count by 1.

Calling this method with an instance with non-zero reference-count is safe, but likely to lead to memory leaks (or the process being aborted, if the recorded count is very high).

pub fn pin(value: T) -> Pin<Self> where
    T: Sized, 

Creates a new instance of Pin<Arc<_>> by moving value into a new heap allocation.

This increases the intrusive reference-count by 1.

Calling this method with an instance with non-zero reference-count is safe, but likely to lead to memory leaks (or the process being aborted, if the recorded count is very high).

pub fn try_unpin(this: Pin<Self>) -> Result<T, Pin<Self>> where
    T: Sized + Unpin, 

Errors

Iff this Arc is not an exclusive handle.

pub fn try_unwrap(this: Self) -> Result<T, Self> where
    T: Sized, 

Errors

Iff this Arc is not an exclusive handle.

pub unsafe fn from_raw(raw_value: NonNull<T>) -> Self

Constructs an Arc instance from a compatible value pointer.

Safety

The pointer raw_value must have been created by leaking the heap-allocated value in a compatible unpinned container.

Containers are incompatible if their type parameter differs in a way that makes the equivalent pointer reinterpretation cast invalid. Otherwise:

(Arc and Rc are compatible. Box is compatible iff the internal reference count had been incremented to at least 1 at the time of leaking.)

For every time the instance that pointer points to was leaked, this function must be called at most once.

The data raw_value points to may be in use only by Arc.

pub unsafe fn pinned_from_raw(raw_value: NonNull<T>) -> Pin<Self>

Constructs a pinned Arc instance from a compatible value pointer.

Safety

The pointer raw_value must have been created by leaking the heap-allocated value in a compatible container.

Containers are incompatible if their type parameter differs in a way that makes the equivalent pointer reinterpretation cast invalid. Otherwise:

(Arc and Rc are compatible. Box is compatible iff the internal reference count had been incremented to at least 1 at the time of leaking.)

For every time the instance that pointer points to was leaked, this function must be called at most once.

The data raw_value points to may be in use only by Arc.

pub unsafe fn borrow_from_inner_ref<'a>(inner: &'a &'a T) -> &'a Self

Unsafely borrows a shared reference to an Arc-managed instance as Arc.

This is purely a reinterpretation cast.

Safety

inner must be a reference to a reference to an instance managed by Arc.

pub unsafe fn borrow_pin_from_inner_ref<'a>(inner: &'a &'a T) -> &'a Pin<Self>

Unsafely borrows a shared reference to a Pin<Arc>-managed instance as Pin<Arc>.

This is purely a reinterpretation cast.

Safety

inner must be a reference to a reference to an instance managed by Pin<Arc>.

pub fn leak(this: Self) -> NonNull<T>

Unwraps the payload pointer contained in the current instance.

This does not decrease the reference-count.

pub fn leak_pinned(this: Pin<Self>) -> NonNull<T>

Unwraps the payload pointer contained in the current instance.

This does not decrease the reference-count.

Safety Notes

Keep in mind that the pinning invariants, including the drop guarantee, must still be upheld.

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

Checks whether two instances of Arc<T> point to the same instance.

pub fn make_mut(this: &mut Pin<Self>) -> ExclusivePin<'_, T> where
    T: Sized + ManagedClone, 

Ensures the payload is exclusively pointed to by this Arc<T>, cloning it if necessary, and gives access to a Pin<&mut T> that safely can not be used to clone the Arc<T>.

pub fn get_mut(this: &mut Pin<Self>) -> Option<ExclusivePin<'_, T>>

Checks whether the payload is exclusively pointed to by this Arc<T> and, if this is the case, gives access to a Pin<&mut T> that safely can not be used to clone the Arc<T>.

pub fn downcast<U>(this: Self) -> Result<Arc<U>, Self> where
    T: Any,
    U: Any + IntrusivelyCountable, 

Attempts to cast this Arc into once of concrete type U.

Errors

Iff the underlying instance isn’t a U.

pub fn downcast_pinned<U>(this: Pin<Self>) -> Result<Pin<Arc<U>>, Pin<Self>> where
    T: Any,
    U: Any + IntrusivelyCountable, 

Attempts to cast this Arc into once of concrete type U.

Errors

Iff the underlying instance isn’t a U.

Trait Implementations

impl<T: ?Sized + IntrusivelyCountable> AsRef<T> for Arc<T>

fn as_ref(&self) -> &T

Performs the conversion.

impl<T: ?Sized + IntrusivelyCountable> Borrow<T> for Arc<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: ?Sized + IntrusivelyCountable> Clone for Arc<T>

fn clone(&self) -> Self

Makes a clone of this Arc, pointing to the same instance.

This increases the strong reference count by 1.

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

Performs copy-assignment from source.

impl<T: ?Sized + IntrusivelyCountable> Debug for Arc<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T: ?Sized + IntrusivelyCountable> Default for Arc<T> where
    T: Default, 

fn default() -> Self

Returns the “default value” for a type.

impl<T: ?Sized + IntrusivelyCountable> Deref for Arc<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized + IntrusivelyCountable> Display for Arc<T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<T: ?Sized + IntrusivelyCountable> Drop for Arc<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized + IntrusivelyCountable> From<Arc<T>> for Pin<Arc<T>> where
    T: Unpin, 

fn from(unpinned: Arc<T>) -> Self

Performs the conversion.

impl<T: ?Sized + IntrusivelyCountable> From<Box<T, Global>> for Arc<T>

fn from(box_: Box<T>) -> Self

Converts a Box into an Arc without reallocating.

impl<'a, B: ?Sized + IntrusivelyCountable> From<Cow<'a, B>> for Arc<B> where
    B: ToOwned,
    Arc<B>: From<B::Owned>, 

fn from(cow: Cow<'a, B>) -> Self

Always converts into an exclusive instance, either by copying or by moving the value.

impl<T: ?Sized + IntrusivelyCountable> From<Pin<Arc<T>>> for Arc<T> where
    T: Unpin, 

fn from(pinned: Pin<Arc<T>>) -> Self

Performs the conversion.

impl<T: Sized + IntrusivelyCountable> From<T> for Arc<T>

fn from(value: T) -> Self

Performs the conversion.

impl<T: ?Sized + IntrusivelyCountable> Hash for Arc<T> where
    T: Hash, 

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 + IntrusivelyCountable> Ord for Arc<T> where
    T: Ord, 

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<T: ?Sized + IntrusivelyCountable, O: ?Sized + IntrusivelyCountable> PartialEq<Arc<O>> for Arc<T> where
    T: PartialEq<O>, 

fn eq(&self, other: &Arc<O>) -> 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 !=.

impl<T: ?Sized + IntrusivelyCountable, O: ?Sized + IntrusivelyCountable> PartialOrd<Arc<O>> for Arc<T> where
    T: PartialOrd<O>, 

fn partial_cmp(&self, other: &Arc<O>) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<T: ?Sized + IntrusivelyCountable> Pointer for Arc<T>

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

Formats the value using the given formatter.

impl<T: ?Sized + IntrusivelyCountable> Eq for Arc<T> where
    T: Eq, 

impl<T: ?Sized + IntrusivelyCountable> Send for Arc<T> where
    T: Sync + Send, 

impl<T: ?Sized + IntrusivelyCountable> Sync for Arc<T> where
    T: Sync + Send, 

impl<T: ?Sized + IntrusivelyCountable> Unpin for Arc<T>