Struct Arc

pub struct Arc<T: ?Sized> { /* private fields */ }

A thread-safe reference-counted pointer.

Trait Implementations

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

fn as_ref(&self) -> &T

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

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

fn borrow(&self) -> &T

Immutably borrows from an owned value.

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

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

Makes a clone of the Arc pointer.

This creates another pointer to the same allocation, increasing the reference count.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: Default> Default for Arc<T>

fn default() -> Arc<T>

Creates a new Arc<T>, with the Default value for T.

Examples

use std::sync::Arc;

let x: Arc<i32> = Default::default();
assert_eq!(*x, 0);

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Drops the Arc.

This will decrement the reference count.

Examples

use std::sync::Arc;

struct Foo;

impl Drop for Foo {
    fn drop(&mut self) {
        println!("dropped!");
    }
}

let foo  = Arc::new(Foo);
let foo2 = Arc::clone(&foo);

drop(foo);    // Doesn't print anything
drop(foo2);   // Prints "dropped!"

impl<T> From<T> for Arc<T>

fn from(t: T) -> Self

Converts to this type from the input type.

impl<T: ?Sized + Hash> Hash for Arc<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<T: ?Sized> Into<Arc<T>> for UniqueArc<T>

fn into(self) -> Arc<T>

Converts this type into the (usually inferred) input type.

impl<T: ?Sized> IntoMut<T> for Arc<T>

unsafe fn get_mut_unchecked(this: &Self) -> &mut T

Obtain a mutable reference to the wrapped value without performing runtime checks for upholding any invariants.

Safety: Calling this is safe if and only if can_make_mut returns true.

type MutablePointer = UniqueArc<T>

fn can_make_mut(this: &Self) -> bool

Check whether converting into a mutable version would succeed.

unsafe fn into_mut_unchecked(this: Self) -> Self::MutablePointer

Convert into a mutable version without performing runtime checks for upholding any invariants.

fn into_mut(this: Self) -> Result<Self::MutablePointer, Self>

Try converting into a mutable version of the pointer.

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

Try obtaining a mutable reference to the wrapped value.

impl<T: ?Sized + Ord> Ord for Arc<T>

fn cmp(&self, other: &Arc<T>) -> Ordering

Comparison for two Arcs.

The two are compared by calling cmp() on their inner values.

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<T: ?Sized + PartialEq> PartialEq for Arc<T>

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

Equality for two Arcs.

Two Arcs are equal if their inner values are equal, even if they are stored in different allocation. This implementation does not check for pointer equality.

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

Inequality for two Arcs.

Two Arcs are unequal if their inner values are unequal. This implementation does not check for pointer equality.

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

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

Partial comparison for two Arcs.

The two are compared by calling partial_cmp() on their inner values.

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

Less-than comparison for two Arcs.

The two are compared by calling < on their inner values.

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

‘Less than or equal to’ comparison for two Arcs.

The two are compared by calling <= on their inner values.

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

Greater-than comparison for two Arcs.

The two are compared by calling > on their inner values.

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

‘Greater than or equal to’ comparison for two Arcs.

The two are compared by calling >= on their inner values.

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

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

Formats the value using the given formatter.

impl<T: ?Sized> ReferenceCounted<T> for Arc<T>

fn reference_count(this: &Self) -> usize

Get the number of owning pointers referring to the same allocation.

impl<T: ?Sized> SmartPointer<T> for Arc<T>

fn new(data: T) -> Arc<T>

where T: Sized,

Construct a new smart pointer, containing the given value.

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

where T: Sized,

Try to obtain ownership of the wrapped value.

fn ptr_eq(a: Self, b: Self) -> bool

Returns whether two smart pointers point to the same location in memory.

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

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

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

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