Struct cargo::core::gc::Gc

pub struct Gc<'a, 'gctx> {
    gctx: &'gctx GlobalContext,
    global_cache_tracker: &'a mut GlobalCacheTracker,
    lock: CacheLock<'gctx>,
}

Garbage collector.

See the module docs at crate::core::gc for more information on GC.

Fields

gctx: &'gctx GlobalContext

global_cache_tracker: &'a mut GlobalCacheTracker

lock: CacheLock<'gctx>

A lock on the package cache.

This is important to be held, since we don’t want multiple cargos to be allowed to write to the cache at the same time, or for others to read while we are modifying the cache.

Implementations

impl<'a, 'gctx> Gc<'a, 'gctx>

pub fn new( gctx: &'gctx GlobalContext, global_cache_tracker: &'a mut GlobalCacheTracker, ) -> CargoResult<Gc<'a, 'gctx>>

fn auto(&mut self, clean_ctx: &mut CleanContext<'gctx>) -> CargoResult<()>

Performs automatic garbage cleaning.

This returns immediately without doing work if garbage collection has been performed recently (since gc.auto.frequency).

pub fn gc( &mut self, clean_ctx: &mut CleanContext<'gctx>, gc_opts: &GcOpts, ) -> CargoResult<()>

Performs garbage collection based on the given options.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes