Nix 2.26.3
Nix, the purely functional package manager; unstable internal interfaces
 
Loading...
Searching...
No Matches
nix::GCOptions Struct Reference

Public Types

enum  GCAction { gcReturnLive , gcReturnDead , gcDeleteDead , gcDeleteSpecific }
 

Public Attributes

GCAction action {gcDeleteDead}
 
bool ignoreLiveness {false}
 
StorePathSet pathsToDelete
 
uint64_t maxFreed {std::numeric_limits<uint64_t>::max()}
 

Member Enumeration Documentation

◆ GCAction

Garbage collector operation:

  • gcReturnLive: return the set of paths reachable from (i.e. in the closure of) the roots.
  • gcReturnDead: return the set of paths not reachable from the roots.
  • gcDeleteDead: actually delete the latter set.
  • gcDeleteSpecific: delete the paths listed in pathsToDelete, insofar as they are not reachable.

Member Data Documentation

◆ ignoreLiveness

bool nix::GCOptions::ignoreLiveness {false}

If ignoreLiveness is set, then reachability from the roots is ignored (dangerous!). However, the paths must still be unreferenced within the store (i.e., there can be no other store paths that depend on them).

◆ maxFreed

uint64_t nix::GCOptions::maxFreed {std::numeric_limits<uint64_t>::max()}

Stop after at least maxFreed bytes have been freed.

◆ pathsToDelete

StorePathSet nix::GCOptions::pathsToDelete

For gcDeleteSpecific, the paths to delete.


The documentation for this struct was generated from the following file: