System.Nix.Internal.StorePath

Documentation

data StorePath

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.

storeDir: The root of the Nix store (e.g. /nix/store).

See the StoreDir haddocks for details on why we represent this at the type level.

Constructors

StorePath

Fields

• storePathHash :: !(Digest StorePathHashAlgo)

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

• storePathName :: !StorePathName

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

• storePathRoot :: !FilePath

  Root of the store

Instances

Eq StorePath

Defined in System.Nix.Internal.StorePath

Methods

(==) :: StorePath -> StorePath -> Bool

(/=) :: StorePath -> StorePath -> Bool

Ord StorePath

Defined in System.Nix.Internal.StorePath

Methods

compare :: StorePath -> StorePath -> Ordering

(<) :: StorePath -> StorePath -> Bool

(<=) :: StorePath -> StorePath -> Bool

(>) :: StorePath -> StorePath -> Bool

(>=) :: StorePath -> StorePath -> Bool

max :: StorePath -> StorePath -> StorePath

min :: StorePath -> StorePath -> StorePath

Show StorePath

Defined in System.Nix.Internal.StorePath

Methods

showsPrec :: Int -> StorePath -> ShowS

show :: StorePath -> String

showList :: [StorePath] -> ShowS

Hashable StorePath

Defined in System.Nix.Internal.StorePath

Methods

hashWithSalt :: Int -> StorePath -> Int

hash :: StorePath -> Int

newtype StorePathName

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).

Constructors

StorePathName

Fields

• unStorePathName :: Text

  Extract the contents of the name.

Instances

Eq StorePathName

Defined in System.Nix.Internal.StorePath

Methods

(==) :: StorePathName -> StorePathName -> Bool

(/=) :: StorePathName -> StorePathName -> Bool

Ord StorePathName

Defined in System.Nix.Internal.StorePath

Methods

compare :: StorePathName -> StorePathName -> Ordering

(<) :: StorePathName -> StorePathName -> Bool

(<=) :: StorePathName -> StorePathName -> Bool

(>) :: StorePathName -> StorePathName -> Bool

(>=) :: StorePathName -> StorePathName -> Bool

max :: StorePathName -> StorePathName -> StorePathName

min :: StorePathName -> StorePathName -> StorePathName

Hashable StorePathName

Defined in System.Nix.Internal.StorePath

Methods

hashWithSalt :: Int -> StorePathName -> Int

hash :: StorePathName -> Int

type StorePathHashAlgo = 'Truncated 20 'SHA256

The hash algorithm used for store path hashes.

type StorePathSet = HashSet StorePath

A set of StorePaths.

data ContentAddressableAddress

An address for a content-addressable store path, i.e. one whose store path hash is purely a function of its contents (as opposed to paths that are derivation outputs, whose hashes are a function of the contents of the derivation file instead).

For backwards-compatibility reasons, the same information is encodable in multiple ways, depending on the method used to add the path to the store. These unfortunately result in separate store paths.

Constructors

Text !(Digest 'SHA256)

The path is a plain file added via makeTextPath or addTextToStore. It is addressed according to a sha256sum of the file contents.

Fixed !NarHashMode !SomeNamedDigest

The path was added to the store via makeFixedOutputPath or addToStore. It is addressed according to some hash algorithm applied to the nar serialization via some NarHashMode.

data NarHashMode

Schemes for hashing a nix archive.

For backwards-compatibility reasons, there are two different modes here, even though Recursive should be able to cover both.

Constructors

RegularFile

Require the nar to represent a non-executable regular file.

Recursive

Hash an arbitrary nar, including a non-executable regular file if so desired.

makeStorePathName :: Text -> Either String StorePathName

reasonInvalid :: Text -> String

validStorePathName :: Text -> Bool

validStorePathNameChar :: Char -> Bool

type RawFilePath = ByteString

Copied from RawFilePath in the unix package, duplicated here to avoid the dependency.

storePathToRawFilePath :: StorePath -> RawFilePath

Render a StorePath as a RawFilePath.

storePathToFilePath :: StorePath -> FilePath

Render a StorePath as a FilePath.

storePathToText :: StorePath -> Text

Render a StorePath as a Text.

storePathToNarInfo :: StorePath -> ByteString

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

parsePath :: FilePath -> ByteString -> Either String StorePath

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

pathParser :: FilePath -> Parser StorePath