Nix 2.26.3
Nix, the purely functional package manager; unstable internal interfaces
 
Loading...
Searching...
No Matches
nix::StoreConfig Struct Referenceabstract
Inheritance diagram for nix::StoreConfig:
nix::StoreDirConfig nix::Config nix::AbstractConfig nix::BinaryCacheStoreConfig nix::CommonSSHStoreConfig nix::DummyStoreConfig nix::LocalFSStoreConfig nix::RemoteStoreConfig nix::Store nix::BinaryCacheStore nix::HttpBinaryCacheStoreConfig nix::LocalBinaryCacheStoreConfig nix::S3BinaryCacheStoreConfig nix::LegacySSHStoreConfig nix::SSHStoreConfig nix::DummyStore nix::LocalFSStore nix::LocalStoreConfig nix::MountedSSHStoreConfig nix::UDSRemoteStoreConfig nix::RemoteStore nix::SSHStoreConfig nix::UDSRemoteStoreConfig nix::BinaryCacheStore nix::DummyStore nix::GcStore nix::LegacySSHStore nix::LocalFSStore nix::LogStore nix::RemoteStore

Public Types

using Params = StoreReference::Params
 
- Public Types inherited from nix::Config
using Settings = std::map<std::string, SettingData>
 

Public Member Functions

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 ()
 

Static Public Member Functions

static StringSet getDefaultSystemFeatures ()
 

Public Attributes

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

- Protected Member Functions inherited from nix::AbstractConfig
 AbstractConfig (StringMap initials={})
 
- Protected Attributes inherited from nix::AbstractConfig
StringMap unknownSettings
 

Member Function Documentation

◆ doc()

◆ experimentalFeature()

virtual std::optional< ExperimentalFeature > nix::StoreConfig::experimentalFeature ( ) const
inlinevirtual

An experimental feature this type store is gated, if it is to be experimental.

Reimplemented in nix::LocalOverlayStoreConfig, and nix::MountedSSHStoreConfig.

◆ name()

Member Data Documentation

◆ isTrusted

const Setting<bool> nix::StoreConfig::isTrusted
Initial value:
{this, false, "trusted",
R"(
Whether paths from this store can be used as substitutes
even if they are not signed by a key listed in the
[`trusted-public-keys`](@docroot@/command-ref/conf-file.md#conf-trusted-public-keys)
setting.
)"}

◆ pathInfoCacheSize

const Setting<int> nix::StoreConfig::pathInfoCacheSize
Initial value:
{this, 65536, "path-info-cache-size",
"Size of the in-memory store path metadata cache."}

◆ priority

Setting<int> nix::StoreConfig::priority
Initial value:
{this, 0, "priority",
R"(
Priority of this store when used as a [substituter](@docroot@/command-ref/conf-file.md#conf-substituters).
A lower value means a higher priority.
)"}

◆ systemFeatures

Setting<StringSet> nix::StoreConfig::systemFeatures
Initial value:
{this, getDefaultSystemFeatures(),
"system-features",
R"(
Optional [system features](@docroot@/command-ref/conf-file.md#conf-system-features) available on the system this store uses to build derivations.
Example: `"kvm"`
)",
{},
false}

◆ wantMassQuery

Setting<bool> nix::StoreConfig::wantMassQuery
Initial value:
{this, false, "want-mass-query",
R"(
Whether this store can be queried efficiently for path validity when used as a [substituter](@docroot@/command-ref/conf-file.md#conf-substituters).
)"}

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