nix::DerivedPath Struct Reference

#include <derived-path.hh>

Inheritance diagram for nix::DerivedPath:

Public Types
using	Raw = derived_path::detail::DerivedPathRaw
using	Opaque = DerivedPathOpaque
using	Built = DerivedPathBuilt

Public Member Functions
const Raw &	raw () const
const StorePath &	getBaseStorePath () const
std::string	to_string (const Store &store) const
std::string	to_string_legacy (const Store &store) const
kj::Promise< Result< JSON > >	toJSON (Store &store) const

Static Public Member Functions
static DerivedPath	parse (const Store &store, std::string_view, const ExperimentalFeatureSettings &xpSettings=experimentalFeatureSettings)
static DerivedPath	parseLegacy (const Store &store, std::string_view, const ExperimentalFeatureSettings &xpSettings=experimentalFeatureSettings)
static DerivedPath	fromSingle (const SingleDerivedPath &)

Detailed Description

A "derived path" is a very simple sort of expression that evaluates to one or more (concrete) store paths. It is either:

• opaque, in which case it is just a single concrete store path with possibly no known derivation
• built, in which case it is a pair of a derivation path and some output names.

Member Function Documentation

fromSingle()

DerivedPath nix::DerivedPath::fromSingle ( const SingleDerivedPath & req )

static

Convert a SingleDerivedPath to a DerivedPath.

getBaseStorePath()

const StorePath & nix::DerivedPath::getBaseStorePath

(

)

const

Get the store path this is ultimately derived from (by realising and projecting outputs).

Note that this is not a property of the store object being referred to, but just of this path — how we happened to be referring to that store object. In other words, this means this function breaks "referential transparency". It should therefore be used only with great care.

parse()

DerivedPath nix::DerivedPath::parse ( const Store & store, std::string_view s, const ExperimentalFeatureSettings & xpSettings = experimentalFeatureSettings )

static

Uses ^ as the separator

Parameters

xpSettings

Stop-gap to avoid globals during unit tests.

parseLegacy()

DerivedPath nix::DerivedPath::parseLegacy ( const Store & store, std::string_view s, const ExperimentalFeatureSettings & xpSettings = experimentalFeatureSettings )

static

Uses ! as the separator

Parameters

xpSettings

Stop-gap to avoid globals during unit tests.

to_string()

std::string nix::DerivedPath::to_string

(

const Store &

store

)

const

Uses ^ as the separator

to_string_legacy()

std::string nix::DerivedPath::to_string_legacy

(

const Store &

store

)

const

Uses ! as the separator

---

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

• lix/libstore/derived-path.hh
• lix/libstore/derived-path.cc