Nix 2.26.3
Nix, the purely functional package manager; unstable internal interfaces
 
Loading...
Searching...
No Matches
nix::BinaryCacheStoreConfig Struct Reference
Inheritance diagram for nix::BinaryCacheStoreConfig:
nix::StoreConfig nix::StoreDirConfig nix::Config nix::AbstractConfig nix::BinaryCacheStore nix::HttpBinaryCacheStoreConfig nix::LocalBinaryCacheStoreConfig nix::S3BinaryCacheStoreConfig nix::HttpBinaryCacheStore nix::LocalBinaryCacheStore nix::S3BinaryCacheStore nix::HttpBinaryCacheStore nix::LocalBinaryCacheStore

Public Member Functions

 StoreConfig ()=delete
 
- Public Member Functions inherited from nix::StoreConfig
virtual const std::string name ()=0
 
virtual std::string doc ()
 
virtual std::optional< ExperimentalFeatureexperimentalFeature () const
 
 StoreDirConfig ()=delete
 
- Public Member Functions inherited from nix::StoreDirConfig
StorePath parseStorePath (std::string_view path) const
 
std::optional< StorePathmaybeParseStorePath (std::string_view path) const
 
std::string printStorePath (const StorePath &path) const
 
StorePathSet parseStorePathSet (const PathSet &paths) const
 
PathSet printStorePathSet (const StorePathSet &path) const
 
std::string showPaths (const StorePathSet &paths)
 
bool isInStore (PathView path) const
 
bool isStorePath (std::string_view path) const
 
std::pair< StorePath, PathtoStorePath (PathView path) const
 
StorePath makeStorePath (std::string_view type, std::string_view hash, std::string_view name) const
 
StorePath makeStorePath (std::string_view type, const Hash &hash, std::string_view name) const
 
StorePath makeOutputPath (std::string_view id, const Hash &hash, std::string_view name) const
 
StorePath makeFixedOutputPath (std::string_view name, const FixedOutputInfo &info) const
 
StorePath makeFixedOutputPathFromCA (std::string_view name, const ContentAddressWithReferences &ca) const
 
std::pair< StorePath, HashcomputeStorePath (std::string_view name, const SourcePath &path, ContentAddressMethod method=FileIngestionMethod::NixArchive, HashAlgorithm hashAlgo=HashAlgorithm::SHA256, const StorePathSet &references={}, PathFilter &filter=defaultPathFilter) const
 
 Config (StringMap initials={})
 
- Public Member Functions inherited from nix::Config
 Config (StringMap initials={})
 
bool set (const std::string &name, const std::string &value) override
 
void addSetting (AbstractSetting *setting)
 
void getSettings (std::map< std::string, SettingInfo > &res, bool overriddenOnly=false) override
 
void resetOverridden () override
 
nlohmann::json toJSON () override
 
std::string toKeyValue () override
 
void convertToArgs (Args &args, const std::string &category) override
 
- Public Member Functions inherited from nix::AbstractConfig
void applyConfig (const std::string &contents, const std::string &path="<unknown>")
 
void warnUnknownSettings ()
 
void reapplyUnknownSettings ()
 

Public Attributes

const Setting< std::string > compression
 
const Setting< bool > writeNARListing
 
const Setting< bool > writeDebugInfo
 
const Setting< PathsecretKeyFile
 
const Setting< PathlocalNarCache
 
const Setting< bool > parallelCompression
 
const Setting< intcompressionLevel
 
- Public Attributes inherited from nix::StoreConfig
const Setting< intpathInfoCacheSize
 
const Setting< bool > isTrusted
 
Setting< intpriority
 
Setting< bool > wantMassQuery
 
Setting< StringSet > systemFeatures
 
- Public Attributes inherited from nix::StoreDirConfig
const PathSetting storeDir_
 
const Path storeDir = storeDir_
 

Additional Inherited Members

- Public Types inherited from nix::StoreConfig
using Params = StoreReference::Params
 
- Public Types inherited from nix::Config
using Settings = std::map<std::string, SettingData>
 
- Static Public Member Functions inherited from nix::StoreConfig
static StringSet getDefaultSystemFeatures ()
 
- Protected Member Functions inherited from nix::AbstractConfig
 AbstractConfig (StringMap initials={})
 
- Protected Attributes inherited from nix::AbstractConfig
StringMap unknownSettings
 

Member Data Documentation

◆ compression

const Setting<std::string> nix::BinaryCacheStoreConfig::compression
Initial value:
{this, "xz", "compression",
"NAR compression method (`xz`, `bzip2`, `gzip`, `zstd`, or `none`)."}

◆ compressionLevel

const Setting<int> nix::BinaryCacheStoreConfig::compressionLevel
Initial value:
{this, -1, "compression-level",
R"(
The *preset level* to be used when compressing NARs.
The meaning and accepted values depend on the compression method selected.
`-1` specifies that the default compression level should be used.
)"}

◆ localNarCache

const Setting<Path> nix::BinaryCacheStoreConfig::localNarCache
Initial value:
{this, "", "local-nar-cache",
"Path to a local cache of NARs fetched from this binary cache, used by commands such as `nix store cat`."}

◆ parallelCompression

const Setting<bool> nix::BinaryCacheStoreConfig::parallelCompression
Initial value:
{this, false, "parallel-compression",
"Enable multi-threaded compression of NARs. This is currently only available for `xz` and `zstd`."}

◆ secretKeyFile

const Setting<Path> nix::BinaryCacheStoreConfig::secretKeyFile
Initial value:
{this, "", "secret-key",
"Path to the secret key used to sign the binary cache."}

◆ writeDebugInfo

const Setting<bool> nix::BinaryCacheStoreConfig::writeDebugInfo
Initial value:
{this, false, "index-debug-info",
R"(
Whether to index DWARF debug info files by build ID. This allows [`dwarffs`](https://github.com/edolstra/dwarffs) to
fetch debug info on demand
)"}

◆ writeNARListing

const Setting<bool> nix::BinaryCacheStoreConfig::writeNARListing
Initial value:
{this, false, "write-nar-listing",
"Whether to write a JSON file that lists the files in each NAR."}

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