deprecated-features.hh File Reference

#include "lix/libutil/error.hh"
#include "lix/libutil/json-fwd.hh"
#include "lix/libutil/types.hh"
#include <type_traits>
#include "deprecated-features.gen.inc"

Go to the source code of this file.

Classes
struct	nix::json::avoids_null< DeprecatedFeature >
class	nix::MissingDeprecatedFeature

Typedefs
using	nix::Dep = DeprecatedFeature

Enumerations
enum struct	nix::DeprecatedFeature { NumDepFeatures }
enum struct	DeprecatedFeatures

Functions
DeprecatedFeatures	nix::operator| (DeprecatedFeatures a, DeprecatedFeatures b)
DeprecatedFeatures	nix::operator| (DeprecatedFeatures a, DeprecatedFeature b)
DeprecatedFeatures	nix::operator& (DeprecatedFeatures a, DeprecatedFeature b)
const std::optional< DeprecatedFeature >	nix::parseDeprecatedFeature (const std::string_view &name)
std::string_view	nix::showDeprecatedFeature (const DeprecatedFeature tag)
std::ostream &	nix::operator<< (std::ostream &str, const DeprecatedFeature &feature)
DeprecatedFeatures	nix::parseDeprecatedFeatures (const std::set< std::string > &rawFeatures)
JSON	nix::documentDeprecatedFeatures ()
void	nix::to_json (JSON &j, const DeprecatedFeature &feature)
void	nix::from_json (const JSON &j, DeprecatedFeature &feature)
void	nix::to_json (JSON &j, const DeprecatedFeatures &f)
void	nix::from_json (const JSON &j, DeprecatedFeatures &f)

Typedef Documentation

Dep

using nix::Dep = DeprecatedFeature

Just because writing DeprecatedFeature::UrlLiterals is way too long

Enumeration Type Documentation

DeprecatedFeature

enum struct nix::DeprecatedFeature

strong

The list of available deprecated features.

Reminder: New deprecated features should start out with a warning without throwing an error. See the developer documentation for details.

Function Documentation

documentDeprecatedFeatures()

JSON nix::documentDeprecatedFeatures

(

)

Compute the documentation of all deprecated features.

See doc/manual for how this information is used.

operator<<()

std::ostream & nix::operator<<	(	std::ostream &	str,
		const DeprecatedFeature &	feature )

Shorthand for str << showDeprecatedFeature(feature).

parseDeprecatedFeature()

const std::optional< DeprecatedFeature > nix::parseDeprecatedFeature

(

const std::string_view &

name

)

Parse a deprecated feature (enum value) from its name. Deprecated feature flag names are hyphenated and do not contain spaces.

parseDeprecatedFeatures()

DeprecatedFeatures nix::parseDeprecatedFeatures

(

const std::set< std::string > &

)

Parse a set of strings to the corresponding set of deprecated features, ignoring (but warning for) any unknown feature.

showDeprecatedFeature()

std::string_view nix::showDeprecatedFeature

(

const DeprecatedFeature

)

Show the name of a deprecated feature. This is the opposite of parseDeprecatedFeature().

to_json()

void nix::to_json	(	JSON &	,
		const DeprecatedFeature &	)

Semi-magic conversion to and from json. See the nlohmann/json readme for more details.