nix::StoreConfig Struct Reference

Inheritance diagram for nix::StoreConfig:

Public Types
typedef std::map< std::string, std::string >	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< ExperimentalFeature >	experimentalFeature () const
	Config (StringMap initials={})
Public Member Functions inherited from nix::Config
	Config (StringMap initials={})
bool	set (const std::string &name, const std::string &value, const ApplyConfigOptions &options={}) override
void	addSetting (AbstractSetting *setting)
void	getSettings (std::map< std::string, SettingInfo > &res, bool overriddenOnly=false) override
void	resetOverridden () override
JSON	toJSON () override
void	convertToArgs (Args &args, const std::string &category) override
Public Member Functions inherited from nix::AbstractConfig
void	applyConfig (const std::string &contents, const ApplyConfigOptions &options={})
void	warnUnknownSettings ()
void	reapplyUnknownSettings ()

Static Public Member Functions
static StringSet	getDefaultSystemFeatures ()

Public Attributes
const PathsSetting< Path >	storeDir_
const Path	storeDir = storeDir_
const Setting< int >	pathInfoCacheSize
const Setting< bool >	isTrusted
Setting< int >	priority
Setting< bool >	wantMassQuery
Setting< StringSet >	systemFeatures

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

virtual std::string nix::StoreConfig::doc ( )

inlinevirtual

Documentation for this type of store.

Reimplemented in nix::DummyStoreConfig, nix::HttpBinaryCacheStoreConfig, nix::LegacySSHStoreConfig, nix::LocalBinaryCacheStoreConfig, nix::LocalStoreConfig, nix::SSHStoreConfig, and nix::UDSRemoteStoreConfig.

experimentalFeature()

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

inlinevirtual

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

name()

virtual const std::string nix::StoreConfig::name ( )

pure virtual

The name of this type of store.

Implemented in nix::DummyStoreConfig, nix::HttpBinaryCacheStoreConfig, nix::LegacySSHStoreConfig, nix::LocalBinaryCacheStoreConfig, nix::LocalStoreConfig, nix::SSHStoreConfig, and nix::UDSRemoteStoreConfig.

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. A lower value means a higher priority.
        )"}

storeDir_

const PathsSetting<Path> nix::StoreConfig::storeDir_

Initial value:

{this, settings.nixStore,
        "store",
        R"(
          Logical location of the Nix store, usually
          `/nix/store`. Note that you can only copy store paths
          between stores if they have the same `store` setting.
        )"}

systemFeatures

Setting<StringSet> nix::StoreConfig::systemFeatures

Initial value:

{this, getDefaultSystemFeatures(),
        "system-features",
        "Optional features that the system this store builds on implements (like \"kvm\").",
        {},
        
        false}

wantMassQuery

Setting<bool> nix::StoreConfig::wantMassQuery

Initial value:

{this, false, "want-mass-query",
        R"(
          Whether this store (when used as a substituter) can be
          queried efficiently for path validity.
        )"}

---

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

• lix/libstore/store-api.hh
• lix/libstore/store-api.cc