Struct rust_cc::Cc

pub struct Cc<T: ?Sized + Trace + 'static> { /* private fields */ }

A thread-local cycle collected pointer.

See the module-level documentation for more details.

Implementations

impl<T: Trace + 'static> Cc<T>

pub fn new(t: T) -> Cc<T>

Creates a new Cc.

Collection

This method may start a collection when the auto-collect feature is enabled.

See the config module documentation for more details.

Panics

Panics if the automatically-stared collection panics.

pub fn into_inner(self) -> T

Takes out the value inside a Cc.

Panics

Panics if the Cc is not unique (see is_unique).

impl<T: ?Sized + Trace + 'static> Cc<T>

pub fn ptr_eq(this: &Cc<T>, other: &Cc<T>) -> bool

Returns true if the two Ccs point to the same allocation. This function ignores the metadata of dyn Trait pointers.

pub fn strong_count(&self) -> u32

Returns the number of Ccs to the pointed allocation.

pub fn is_unique(&self) -> bool

Returns true if the strong reference count is 1, false otherwise.

pub fn finalize_again(&mut self)

Available on crate feature finalization only.

Makes the value in the managed allocation finalizable again.

Panics

Panics if called during a collection.

pub fn already_finalized(&self) -> bool

Available on crate feature finalization only.

Returns true if the value in the managed allocation has already been finalized, false otherwise.

pub fn mark_alive(&self)

Marks the managed allocation as alive.

Every time a Cc is dropped, the pointed allocation is buffered to be processed in the next collection. This method simply removes the managed allocation from the buffer, potentially reducing the amount of work needed to be done by the collector.

This method is a no-op when called on a Cc pointing to an allocation which is not buffered.

impl<T: Trace + 'static> Cc<Weakable<T>>

pub fn new_weakable(t: T) -> Self

Available on crate feature weak-ptr only.

Creates a new WeakableCc.

pub fn new_cyclic<F>(f: F) -> Cc<Weakable<T>>

where F: FnOnce(&Weak<T>) -> T,

Available on crate feature weak-ptr only.

Creates a new WeakableCc<T> while providing a Weak<T> pointer to the allocation, to allow the creation of a T which holds a weak pointer to itself.

Collection

This method may start a collection when the auto-collect feature is enabled.

See the config module documentation for more details.

Panics

Panics if the provided closure or the automatically-stared collection panics.

Example

#[derive(Trace, Finalize)]
struct Cyclic {
    cyclic: Weak<Self>,
}

let cyclic = Cc::new_cyclic(|weak| {
    Cyclic {
         cyclic: weak.clone(),
    }
});

impl<T: ?Sized + Trace + 'static> Cc<Weakable<T>>

pub fn downgrade(&self) -> Weak<T>

Available on crate feature weak-ptr only.

Creates a new Weak pointer to the managed allocation, increasing the weak reference count.

Panics

Panics if the strong reference count exceeds the maximum supported.

pub fn weak_count(&self) -> u32

Available on crate feature weak-ptr only.

Returns the number of Weaks to the pointed allocation.

Trait Implementations

impl<T: ?Sized + Trace + 'static> Clone for Cc<T>

fn clone(&self) -> Self

Makes a clone of the Cc pointer.

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

Cloning a Cc also marks the managed allocation as alive. See mark_alive for more details.

Panics

Panics if the strong reference count exceeds the maximum supported.

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

Performs copy-assignment from source.

impl<T: ?Sized + Trace + 'static> Deref for Cc<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized + Trace + 'static> Drop for Cc<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized + Trace + 'static> Finalize for Cc<T>

fn finalize(&self)

The finalizer, which is called after an object becomes garbage and before droping it.

impl<T: ?Sized + Trace + 'static> Trace for Cc<T>

fn trace(&self, ctx: &mut Context<'_>)

Traces the contained Ccs. See Trace for more information.

impl<T, U> CoerceUnsized<Cc<U>> for Cc<T>

where T: ?Sized + Trace + Unsize<U> + 'static, U: ?Sized + Trace + 'static,

Available on crate feature nightly only.