Struct CArc 

pub struct CArc<T, TAllocator: Allocator> { /* private fields */ }

A smart pointer that can be used to share ownership of a value.

This struct is equivalent to the standard Arc type, but is #[repr(C)] and thus safe to use across the ffi boundaries.

Implementations

impl<T, TAllocator: Allocator> CArc<T, TAllocator>

pub fn new(value: T) -> Result<Self, CArcError>

where TAllocator: Default,

Creates a new CArc with the default allocator.

Errors

For details see CArcError.

pub fn with_allocator( value: T, allocator: TAllocator, ) -> Result<Self, CArcError>

Creates a new CArc with a custom allocator.

Errors

For details see CArcError.

pub fn strong_count(carc: &Self) -> u32

Returns the number of strong references to the CArc.

pub fn weak_count(carc: &Self) -> u32

Returns the number of weak references to the CArc.

pub const fn data(carc: &Self) -> &T

Returns a reference to the underlying value.

pub fn downgrade( carc: &Self, ) -> Result<CWeak<T, TAllocator>, MaxReferencesExceededError>

Creates a new CWeak reference to the CArc.

Errors

If the weak reference count is too high. Cannot exceed MAX_REFERENCES.

pub fn abandon(carc: Self) -> Option<AbandonResult<T, TAllocator>>

Abandons current CArc.

This function returns None if the underlying strong reference counter is still positive. Otherwise it returns the underlying data and a weak reference to the CArc. In particular the data will be dropped by the caller if that was the last strong reference.

pub const fn into_raw_ptr(carc: Self) -> *mut u8

Converts the CArc into a raw pointer.

Notes

• This method does not touch internal reference counters, self is simply forgotten.
• The caller must ensure that the pointer does not outlive the CArc.

pub const unsafe fn from_raw_ptr(ptr: *mut u8) -> Self

Converts a raw pointer back to a CArc.

Safety

• The caller must ensure that the pointer came from the previous call to CArc::into_raw_ptr.
• The caller must ensure that the raw pointer won’t be used after the call.

Otherwise the behavior is undefined.

Trait Implementations

impl<T, TAllocator: Allocator> AsRef<T> for CArc<T, TAllocator>

fn as_ref(&self) -> &T

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

impl<T, TAllocator: Allocator> Borrow<T> for CArc<T, TAllocator>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T, TAllocator: Allocator> Clone for CArc<T, TAllocator>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, TAllocator: Debug + Allocator> Debug for CArc<T, TAllocator>

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

Formats the value using the given formatter.

impl<T, TAllocator: Allocator> Deref for CArc<T, TAllocator>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, TAllocator: Allocator> Drop for CArc<T, TAllocator>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T: Eq, TAllocator: Allocator> Eq for CArc<T, TAllocator>

impl<T: Hash, TAllocator: Allocator> Hash for CArc<T, TAllocator>

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: Ord, TAllocator: Allocator> Ord for CArc<T, TAllocator>

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

This method returns an Ordering between self and other.

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: PartialEq, TAllocator: Allocator> PartialEq for CArc<T, TAllocator>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd, TAllocator: Allocator> PartialOrd for CArc<T, TAllocator>

fn partial_cmp(&self, other: &Self) -> Option<CmpOrdering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: ReprC, TAllocator: Allocator> ReprC for CArc<T, TAllocator>

const CHECK: ()

This field is used for const checks only.

impl<T, TAllocator: Allocator> TryClone for CArc<T, TAllocator>

type Error = MaxReferencesExceededError

fn try_clone(&self) -> Result<Self, Self::Error>

Tries to clone the type.