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

#include <config.hh>

Inheritance diagram for nix::PathSetting:
nix::BaseSetting< Path > nix::AbstractSetting

Public Member Functions

 PathSetting (Config *options, const Path &def, const std::string &name, const std::string &description, const std::set< std::string > &aliases={})
 
Path parse (const std::string &str) const override
 
Path operator+ (const char *p) const
 
void operator= (const Path &v)
 
- Public Member Functions inherited from nix::BaseSetting< Path >
std::string to_string () const
 
void convertToArg (Args &args, const std::string &category)
 
void convertToArg (Args &args, const std::string &category)
 
std::string to_string () const
 
std::string to_string () const
 
std::string to_string () const
 
void convertToArg (Args &args, const std::string &category)
 
std::string to_string () const
 
std::string to_string () const
 
std::string to_string () const
 
std::string to_string () const
 
 BaseSetting (const Path &def, const bool documentDefault, const std::string &name, const std::string &description, const std::set< std::string > &aliases={}, std::optional< ExperimentalFeature > experimentalFeature=std::nullopt)
 
 operator const Path & () const
 
 operator Path & ()
 
const Pathget () const
 
Pathget ()
 
bool operator== (const U &v2) const
 
bool operator!= (const U &v2) const
 
void operator= (const U &v)
 
virtual void assign (const Path &v)
 
void setDefault (const U &v)
 
void set (const std::string &str, bool append=false) override final
 
bool isAppendable () override final
 
virtual void override (const Path &v)
 
std::string to_string () const override
 
std::string to_string () const
 
std::string to_string () const
 
std::string to_string () const
 
std::string to_string () const
 
std::string to_string () const
 
std::string to_string () const
 
std::string to_string () const
 
std::string to_string () const
 
void convertToArg (Args &args, const std::string &category) override
 
void convertToArg (Args &args, const std::string &category)
 
void convertToArg (Args &args, const std::string &category)
 
void convertToArg (Args &args, const std::string &category)
 
std::map< std::string, nlohmann::json > toJSONObject () const override
 

Additional Inherited Members

- Public Attributes inherited from nix::AbstractSetting
const std::string name
 
const std::string description
 
const std::set< std::string > aliases
 
int created = 123
 
bool overridden = false
 
std::optional< ExperimentalFeatureexperimentalFeature
 
- Protected Member Functions inherited from nix::BaseSetting< Path >
SandboxMode parse (const std::string &str) const
 
void appendOrSet (Strings newValue, bool append)
 
void appendOrSet (StringSet newValue, bool append)
 
void appendOrSet (StringMap newValue, bool append)
 
void appendOrSet (std::set< ExperimentalFeature > newValue, bool append)
 
std::string parse (const std::string &str) const
 
std::optional< std::string > parse (const std::string &str) const
 
bool parse (const std::string &str) const
 
Strings parse (const std::string &str) const
 
void appendOrSet (Strings newValue, bool append)
 
StringSet parse (const std::string &str) const
 
void appendOrSet (StringSet newValue, bool append)
 
std::set< ExperimentalFeatureparse (const std::string &str) const
 
void appendOrSet (std::set< ExperimentalFeature > newValue, bool append)
 
StringMap parse (const std::string &str) const
 
void appendOrSet (StringMap newValue, bool append)
 
SandboxMode parse (const std::string &str) const
 
std::string parse (const std::string &str) const
 
std::optional< std::string > parse (const std::string &str) const
 
bool parse (const std::string &str) const
 
Strings parse (const std::string &str) const
 
StringSet parse (const std::string &str) const
 
std::set< ExperimentalFeatureparse (const std::string &str) const
 
StringMap parse (const std::string &str) const
 
virtual void appendOrSet (Path newValue, bool append)
 
void appendOrSet (Strings newValue, bool append)
 
void appendOrSet (StringSet newValue, bool append)
 
void appendOrSet (StringMap newValue, bool append)
 
void appendOrSet (std::set< ExperimentalFeature > newValue, bool append)
 
void appendOrSet (Strings newValue, bool append)
 
void appendOrSet (StringSet newValue, bool append)
 
void appendOrSet (std::set< ExperimentalFeature > newValue, bool append)
 
void appendOrSet (StringMap newValue, bool append)
 
- Protected Member Functions inherited from nix::AbstractSetting
 AbstractSetting (const std::string &name, const std::string &description, const std::set< std::string > &aliases, std::optional< ExperimentalFeature > experimentalFeature=std::nullopt)
 
nlohmann::json toJSON ()
 
bool isOverridden () const
 
- Protected Attributes inherited from nix::BaseSetting< Path >
Path value
 
const Path defaultValue
 
const bool documentDefault
 

Detailed Description

A special setting for Paths. These are automatically canonicalised (e.g. "/foo//bar/" becomes "/foo/bar").

It is mandatory to specify a path; i.e. the empty string is not permitted.

Member Function Documentation

◆ parse()

Path nix::PathSetting::parse ( const std::string & str) const
overridevirtual

Parse the string into a T.

Used by set().

Reimplemented from nix::BaseSetting< Path >.


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