Struct LocalRtGc 

pub struct LocalRtGc { /* private fields */ }

A simple garbage collector which collects resources dropped on a realtime thread and safely deallocates them on another thread.

Unlike GlobalRtGc, this version does not use global statics.

The performance characteristics of the ArcGc, OwnedGc, and OwnedGcUnsized smart pointers are equivalant to Arc when reading (but constructing them is a bit more expensive).

Example

let mut collector = LocalRtGc::new();
let handle = collector.handle();

let value_1 = ArcGc::new_loc(String::from("foo"), &handle);
// Same as `ArcGc` but for `!Sync` data.
let value_2 = OwnedGc::new_loc(String::from("bar"), &handle);

// A simulated "realtime thread"
let rt_thread = std::thread::spawn(move || {
    std::thread::sleep(Duration::from_millis(15));

    // Dropping the values on the realtime thread is realtime-safe
    // because the contents are automatically collected and
    // deallocated on a separate non-realtime thread.
    let _ = value_1;
    let _ = value_2;
});

// A simulated update loop on the main thread
for _ in 0..4 {
    // Call `collector.collect()` periodically to deallocate any
    // resources that were dropped on the realtime thread.
    collector.collect();

    std::thread::sleep(Duration::from_millis(15));
}

Implementations

impl LocalRtGc

pub fn new() -> Self

pub fn with_capacity(capacity: usize) -> Self

pub fn handle(&self) -> LocalRtGcHandle

pub fn any_dropped(&self) -> bool

Returns true if any allocation has been dropped since the collection cycle.

pub fn num_allocations(&self) -> usize

The total number of allocations currently active in this garbage collector.

pub fn collect(&mut self)

Collect and drop all unused ArcGc resources.

pub fn strong_count(&self) -> usize

The total number of active references to this garbage collector.

Trait Implementations

impl Clone for LocalRtGc

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Collector for LocalRtGc

fn register<T>(&self, data: Arc<T>)

where T: ?Sized + Send + Sync + 'static, Arc<T>: StrongCount,

Register this data with the garbage collector.

fn remove<T>(&self, data: &Arc<T>)

where T: ?Sized + Send + Sync + 'static, Arc<T>: StrongCount,

Called in ArcGc’s Drop implementation.

impl Default for LocalRtGc

fn default() -> Self

Returns the “default value” for a type.