System.Nix.StorePath

The path to the store dir

Many operations need to be parameterized with this, since store paths do not know their own store dir by design.

A path in a Nix store.

From the Nix thesis: A store path is the full path of a store object. It has the following anatomy: storeDir/hashPart-name.

The store directory is *not* included, and must be known from the context. This matches modern C++ Nix, and also represents the fact that store paths for different store directories cannot be mixed.

The 160-bit hash digest reflecting the "address" of the name. Currently, this is a truncated SHA256 hash.

The (typically human readable) name of the path. For packages this is typically the package name and version (e.g. hello-1.2.3).

The name portion of a Nix path.

unStorePathName must only contain a-zA-Z0-9+._?=-, can't start with a -, and must have at least one character (i.e. it must match storePathNameRegex).

Extract the contents of the name.

The hash algorithm used for store path hashes.

Make StorePathHashPart from ByteString (hash part of the StorePath) using specific HashAlgorithm

Extract the contents of the hash.

Reason why a path name or output name is not valid

Make StorePathName from Text (name part of the StorePath) or fail with InvalidNameError if it isn't valid

Parse name (either StorePathName or OutputName)

Reason why a path is not valid

Render a StorePath as a FilePath.

Render a StorePath as a RawFilePath.

Render a StorePath as a Text.

Build narinfo suffix from StorePath which can be used to query binary caches.

Render a StorePathHashPart as a Text. This is used by remote store / database via queryPathFromHashPart

Parse StorePath from ByteString, checking that store directory matches expectedRoot.

Parse StorePath from Text, checking that store directory matches expectedRoot.

Attoparsec StorePath Parser

Paths rarely need to be constructed directly. Prefer parsePath or parsePathFromText

Path hash parts rarely need to be constructed directly. Prefer mkStorePathHashPart Used by remote store in wire protocol