Skip to main content

## Gc

# Struct Gc

Source

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

Expand description

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§

Source§

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

Source

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

Source

#### 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 `cache.auto-clean-frequency`).

Source

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

Performs garbage collection based on the given options.

## Auto Trait Implementations§

§

### impl<'a, 'gctx> Freeze for Gc<'a, 'gctx>

§

### impl<'a, 'gctx> !RefUnwindSafe for Gc<'a, 'gctx>

§

### impl<'a, 'gctx> Send for Gc<'a, 'gctx>

§

### impl<'a, 'gctx> !Sync for Gc<'a, 'gctx>

§

### impl<'a, 'gctx> Unpin for Gc<'a, 'gctx>

§

### impl<'a, 'gctx> UnsafeUnpin for Gc<'a, 'gctx>

§

### impl<'a, 'gctx> !UnwindSafe for Gc<'a, 'gctx>

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
§

### impl<T> Pointable for T

§

#### const ALIGN: usize

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more

## 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