Nix  2.93.0-dev
Lix: A modern, delicious implementation of the Nix package manager; unstable internal interfaces
Loading...
Searching...
No Matches
Public Member Functions | List of all members
nix::PathsSetting< T > Class Template Reference

#include <config.hh>

Inheritance diagram for nix::PathsSetting< T >:
[legend]
Collaboration diagram for nix::PathsSetting< T >:
[legend]

Public Member Functions

 PathsSetting (Config *options, const T &def, const std::string &name, const std::string &description, const std::set< std::string > &aliases={}, const bool documentDefault=true, std::optional< ExperimentalFeature > experimentalFeature=std::nullopt, bool deprecated=false)
 
T parse (const std::string &str, const ApplyConfigOptions &options) const override
 
Path parse (const std::string &str, const ApplyConfigOptions &options) const
 
std::optional< Path > parse (const std::string &str, const ApplyConfigOptions &options) const
 
Paths parse (const std::string &str, const ApplyConfigOptions &options) const
 
PathSet parse (const std::string &str, const ApplyConfigOptions &options) const
 
- Public Member Functions inherited from nix::BaseSetting< T >
 BaseSetting (const T &def, const bool documentDefault, const std::string &name, const std::string &description, const std::set< std::string > &aliases={}, std::optional< ExperimentalFeature > experimentalFeature=std::nullopt, bool deprecated=false)
 
 operator const T & () const
 
const T & get () const
 
template<typename U >
bool operator== (const U &v2) const
 
template<typename U >
bool operator!= (const U &v2) const
 
template<typename U >
void setDefault (const U &v)
 
void set (const std::string &str, bool append=false, const ApplyConfigOptions &options={}) override final
 
void override (const T &v)
 
bool isAppendable () override final
 
std::string to_string () const override
 
void convertToArg (Args &args, const std::string &category) override
 
std::map< std::string, JSON > toJSONObject () const override
 
std::string to_string () const
 
void convertToArg (Args &args, const std::string &category)
 
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
 
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
 
std::string to_string () const
 

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< ExperimentalFeature > experimentalFeature
 
- Protected Member Functions inherited from nix::BaseSetting< T >
virtual void appendOrSet (T newValue, bool append, const ApplyConfigOptions &options)
 
AcceptFlakeConfig parse (const std::string &str, const ApplyConfigOptions &options) const
 
SandboxMode parse (const std::string &str, const ApplyConfigOptions &options) const
 
void appendOrSet (Strings newValue, bool append, const ApplyConfigOptions &options)
 
void appendOrSet (StringSet newValue, bool append, const ApplyConfigOptions &options)
 
void appendOrSet (StringMap newValue, bool append, const ApplyConfigOptions &options)
 
void appendOrSet (ExperimentalFeatures newValue, bool append, const ApplyConfigOptions &options)
 
void appendOrSet (DeprecatedFeatures newValue, bool append, const ApplyConfigOptions &options)
 
std::string parse (const std::string &str, const ApplyConfigOptions &options) const
 
std::optional< std::string > parse (const std::string &str, const ApplyConfigOptions &options) const
 
std::optional< uint16_t > parse (const std::string &str, const ApplyConfigOptions &options) const
 
bool parse (const std::string &str, const ApplyConfigOptions &options) const
 
Strings parse (const std::string &str, const ApplyConfigOptions &options) const
 
void appendOrSet (Strings newValue, bool append, const ApplyConfigOptions &options)
 
StringSet parse (const std::string &str, const ApplyConfigOptions &options) const
 
void appendOrSet (StringSet newValue, bool append, const ApplyConfigOptions &options)
 
ExperimentalFeatures parse (const std::string &str, const ApplyConfigOptions &options) const
 
void appendOrSet (ExperimentalFeatures newValue, bool append, const ApplyConfigOptions &options)
 
DeprecatedFeatures parse (const std::string &str, const ApplyConfigOptions &options) const
 
void appendOrSet (DeprecatedFeatures newValue, bool append, const ApplyConfigOptions &options)
 
StringMap parse (const std::string &str, const ApplyConfigOptions &options) const
 
void appendOrSet (StringMap newValue, bool append, const ApplyConfigOptions &options)
 
- 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)
 
JSON toJSON ()
 
bool isOverridden () const
 
- Protected Attributes inherited from nix::BaseSetting< T >
T value
 
const T defaultValue
 
const bool documentDefault
 
const bool deprecated
 

Detailed Description

template<typename T>
class nix::PathsSetting< T >

A special setting for Paths. These are automatically canonicalised (e.g. "/foo//bar/" becomes "/foo/bar"). The empty string is not permitted when a path is required.

Member Function Documentation

◆ parse() [1/5]

Path nix::PathsSetting< Path >::parse ( const std::string & str,
const ApplyConfigOptions & options ) const
virtual

Parse the string into a T.

Used by set().

Reimplemented from nix::BaseSetting< T >.

◆ parse() [2/5]

std::optional< Path > nix::PathsSetting< std::optional< Path > >::parse ( const std::string & str,
const ApplyConfigOptions & options ) const
virtual

Parse the string into a T.

Used by set().

Reimplemented from nix::BaseSetting< T >.

◆ parse() [3/5]

Paths nix::PathsSetting< Paths >::parse ( const std::string & str,
const ApplyConfigOptions & options ) const
virtual

Parse the string into a T.

Used by set().

Reimplemented from nix::BaseSetting< T >.

◆ parse() [4/5]

PathSet nix::PathsSetting< PathSet >::parse ( const std::string & str,
const ApplyConfigOptions & options ) const
virtual

Parse the string into a T.

Used by set().

Reimplemented from nix::BaseSetting< T >.

◆ parse() [5/5]

template<typename T >
T nix::PathsSetting< T >::parse ( const std::string & str,
const ApplyConfigOptions & options ) const
overridevirtual

Parse the string into a T.

Used by set().

Reimplemented from nix::BaseSetting< T >.

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