Struct triomphe::Arc

[+] Show declaration

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

[−] Expand description

An atomically reference counted shared pointer

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

Implementations

impl<T> Arc<T>[−]

pub fn new(data: T) -> Self[−]

Construct an Arc<T>

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

Convert the Arc 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 OffsetArc for this.

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

Reconstruct the Arc 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 OffsetArc 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 Arc. This is basically an &Arc<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 Arc<T>s if necessary.

pub fn with_raw_offset_arc<F, U>(&self, f: F) -> U where
    F: FnOnce(&OffsetArc<T>) -> U, [−]

Temporarily converts |self| into a bonafide OffsetArc 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 Arc itself -- not the T within it -- for memory reporting.

pub fn into_raw_offset(a: Self) -> OffsetArc<T>[−]

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

pub fn from_raw_offset(a: OffsetArc<T>) -> Self[−]

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

impl<T: ?Sized> Arc<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> Arc<T>[−]

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

Makes a mutable reference to the Arc, cloning if necessary

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

If this Arc is uniquely owned, make_mut() will provide a mutable reference to the contents. If not, make_mut() will create a new Arc 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> Arc<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?).

impl<H, T> Arc<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> Arc<HeaderSlice<HeaderWithLength<H>, [T]>>[−]

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

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

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

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

Trait Implementations

impl<T: ?Sized> AsRef<T> for Arc<T>[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &T[−]

Performs the conversion.

impl<T: ?Sized> Borrow<T> for Arc<T>[+]

[+] Show hidden undocumented items

fn borrow(&self) -> &T[−]

Immutably borrows from an owned value.

impl<T: ?Sized> Clone for Arc<T>[+]

[+] Show hidden undocumented items

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 Arc<T>

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

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<T: Default> Default for Arc<T>[+]

[+] Show hidden undocumented items

fn default() -> Arc<T>[−]

Returns the "default value" for a type.

impl<T: ?Sized> Deref for Arc<T>[+]

[+] Show hidden undocumented items

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T[−]

Dereferences the value.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Arc<T>[+]

[+] Show hidden undocumented items

fn deserialize<D>(deserializer: D) -> Result<Arc<T>, D::Error> where
    D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.

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

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<T: ?Sized> Drop for Arc<T>[+]

[+] Show hidden undocumented items

fn drop(&mut self)[−]

Executes the destructor for this type.

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

impl<T> From<T> for Arc<T>[+]

[+] Show hidden undocumented items

fn from(t: T) -> Self[−]

Performs the conversion.

impl<T: ?Sized + Hash> Hash for Arc<T>[+]

[+] Show hidden undocumented items

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 Arc<T>[+]

[+] Show hidden undocumented items

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

This method returns an Ordering between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

#[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<Arc<T>> for Arc<T>[+]

[+] Show hidden undocumented items

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

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

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

This method tests for !=.

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

[+] Show hidden undocumented items

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

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

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

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

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

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

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

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

fn ge(&self, other: &Arc<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 Arc<T>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

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

impl<T: Serialize> Serialize for Arc<T>[+]

[+] Show hidden undocumented items

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 Arc<T>

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