Nix.Derivation

Use this package to parse and render Nix derivations such as those stored in /nix/store/*.drv files. For example, if you had the following derivation saved at /nix/store/zzhs4fb83x5ygvjqn5rdpmpnishpdgy6-perl-MIME-Types-2.13.drv:

Derive([("devdoc","/nix/store/15x9ii8c3n5wb5lg80cm8x0yk6zy7rha-perl-MIME-Types-2
.13-devdoc","",""),("out","/nix/store/93d75ghjyibmbxgfzwhh4b5zwsxzs44w-perl-MIME
-Types-2.13","","")],[("/nix/store/57h2hjsdkdiwbzilcjqkn46138n1xb4a-perl-5.22.3.
drv",["out"]),("/nix/store/cvdbbvnvg131bz9bwyyk97jpq1crclqr-MIME-Types-2.13.tar.
gz.drv",["out"]),("/nix/store/p5g31bc5x92awghx9dlm065d7j773l0r-stdenv.drv",["out
"]),("/nix/store/x50y5qihwsn0lfjhrf1s81b5hgb9w632-bash-4.4-p5.drv",["out"])],["/
nix/store/cdips4lakfk1qbf1x68fq18wnn3r5r14-builder.sh"],"x86_64-linux","/nix/sto
re/fi3mbd2ml4pbgzyasrlnp0wyy6qi48fh-bash-4.4-p5/bin/bash",["-e","/nix/store/cdip
s4lakfk1qbf1x68fq18wnn3r5r14-builder.sh"],[("AUTOMATED_TESTING","1"),("PERL_AUTO
INSTALL","--skipdeps"),("buildInputs",""),("builder","/nix/store/fi3mbd2ml4pbgzy
asrlnp0wyy6qi48fh-bash-4.4-p5/bin/bash"),("checkTarget","test"),("devdoc","/nix/
store/15x9ii8c3n5wb5lg80cm8x0yk6zy7rha-perl-MIME-Types-2.13-devdoc"),("doCheck",
"1"),("installTargets","pure_install"),("name","perl-MIME-Types-2.13"),("nativeB
uildInputs","/nix/store/nsa311yg8h93wfaacjk16c96a98bs09f-perl-5.22.3"),("out","/
nix/store/93d75ghjyibmbxgfzwhh4b5zwsxzs44w-perl-MIME-Types-2.13"),("outputs","ou
t devdoc"),("propagatedBuildInputs",""),("propagatedNativeBuildInputs",""),("src
","/nix/store/5smhymz7viq8p47mc3jgyvqd003ab732-MIME-Types-2.13.tar.gz"),("stdenv
","/nix/store/s3rlr45jzlzx0d6k2azlpxa5zwzr7xyy-stdenv"),("system","x86_64-linux"
)])

... you could parse that derivation using:

>>> text <- Data.Text.Lazy.IO.readFile "/nix/store/zzhs4fb83x5ygvjqn5rdpmpnishpdgy6-perl-MIME-Types-2.13.drv"
>>> let result = Data.Attoparsec.Text.Lazy.parse Nix.Derivation.parseDerivation text
>>> result
Done "" (Derivation {outputs = fromList [("devdoc",DerivationOutput {path = File
Path "/nix/store/15x9ii8c3n5wb5lg80cm8x0yk6zy7rha-perl-MIME-Types-2.13-devdoc", 
hashAlgo = "", hash = ""}),("out",DerivationOutput {path = FilePath "/nix/store/
93d75ghjyibmbxgfzwhh4b5zwsxzs44w-perl-MIME-Types-2.13", hashAlgo = "", hash = ""
})], inputDrvs = fromList [(FilePath "/nix/store/57h2hjsdkdiwbzilcjqkn46138n1xb4
a-perl-5.22.3.drv",fromList ["out"]),(FilePath "/nix/store/cvdbbvnvg131bz9bwyyk9
7jpq1crclqr-MIME-Types-2.13.tar.gz.drv",fromList ["out"]),(FilePath "/nix/store/
p5g31bc5x92awghx9dlm065d7j773l0r-stdenv.drv",fromList ["out"]),(FilePath "/nix/s
tore/x50y5qihwsn0lfjhrf1s81b5hgb9w632-bash-4.4-p5.drv",fromList ["out"])], input
Srcs = fromList [FilePath "/nix/store/cdips4lakfk1qbf1x68fq18wnn3r5r14-builder.s
h"], platform = "x86_64-linux", builder = FilePath "/nix/store/fi3mbd2ml4pbgzyas
rlnp0wyy6qi48fh-bash-4.4-p5/bin/bash", args = ["-e","/nix/store/cdips4lakfk1qbf1
x68fq18wnn3r5r14-builder.sh"], env = fromList [("AUTOMATED_TESTING","1"),("PERL_
AUTOINSTALL","--skipdeps"),("buildInputs",""),("builder","/nix/store/fi3mbd2ml4p
bgzyasrlnp0wyy6qi48fh-bash-4.4-p5/bin/bash"),("checkTarget","test"),("devdoc","/
nix/store/15x9ii8c3n5wb5lg80cm8x0yk6zy7rha-perl-MIME-Types-2.13-devdoc"),("doChe
ck","1"),("installTargets","pure_install"),("name","perl-MIME-Types-2.13"),("nat
iveBuildInputs","/nix/store/nsa311yg8h93wfaacjk16c96a98bs09f-perl-5.22.3"),("out
","/nix/store/93d75ghjyibmbxgfzwhh4b5zwsxzs44w-perl-MIME-Types-2.13"),("outputs"
,"out devdoc"),("propagatedBuildInputs",""),("propagatedNativeBuildInputs",""),(
"src","/nix/store/5smhymz7viq8p47mc3jgyvqd003ab732-MIME-Types-2.13.tar.gz"),("st
denv","/nix/store/s3rlr45jzlzx0d6k2azlpxa5zwzr7xyy-stdenv"),("system","x86_64-li
nux")]})

... and render the result back to the original derivation:

>>> fmap buildDerivation result
Done "" "Derive([(\"devdoc\",\"/nix/store/15x9ii8c3n5wb5lg80cm8x0yk6zy7rha-perl-
MIME-Types-2.13-devdoc\",\"\",\"\"),(\"out\",\"/nix/store/93d75ghjyibmbxgfzwhh4b
5zwsxzs44w-perl-MIME-Types-2.13\",\"\",\"\")],[(\"/nix/store/57h2hjsdkdiwbzilcjq
kn46138n1xb4a-perl-5.22.3.drv\",[\"out\"]),(\"/nix/store/cvdbbvnvg131bz9bwyyk97j
pq1crclqr-MIME-Types-2.13.tar.gz.drv\",[\"out\"]),(\"/nix/store/p5g31bc5x92awghx
9dlm065d7j773l0r-stdenv.drv\",[\"out\"]),(\"/nix/store/x50y5qihwsn0lfjhrf1s81b5h
gb9w632-bash-4.4-p5.drv\",[\"out\"])],[\"/nix/store/cdips4lakfk1qbf1x68fq18wnn3r
5r14-builder.sh\"],\"x86_64-linux\",\"/nix/store/fi3mbd2ml4pbgzyasrlnp0wyy6qi48f
h-bash-4.4-p5/bin/bash\",[\"-e\",\"/nix/store/cdips4lakfk1qbf1x68fq18wnn3r5r14-b
uilder.sh\"],[(\"AUTOMATED_TESTING\",\"1\"),(\"PERL_AUTOINSTALL\",\"--skipdeps\"
),(\"buildInputs\",\"\"),(\"builder\",\"/nix/store/fi3mbd2ml4pbgzyasrlnp0wyy6qi4
8fh-bash-4.4-p5/bin/bash\"),(\"checkTarget\",\"test\"),(\"devdoc\",\"/nix/store/
15x9ii8c3n5wb5lg80cm8x0yk6zy7rha-perl-MIME-Types-2.13-devdoc\"),(\"doCheck\",\"1
\"),(\"installTargets\",\"pure_install\"),(\"name\",\"perl-MIME-Types-2.13\"),(\
"nativeBuildInputs\",\"/nix/store/nsa311yg8h93wfaacjk16c96a98bs09f-perl-5.22.3\"
),(\"out\",\"/nix/store/93d75ghjyibmbxgfzwhh4b5zwsxzs44w-perl-MIME-Types-2.13\")
,(\"outputs\",\"out devdoc\"),(\"propagatedBuildInputs\",\"\"),(\"propagatedNati
veBuildInputs\",\"\"),(\"src\",\"/nix/store/5smhymz7viq8p47mc3jgyvqd003ab732-MIM
E-Types-2.13.tar.gz\"),(\"stdenv\",\"/nix/store/s3rlr45jzlzx0d6k2azlpxa5zwzr7xyy
-stdenv\"),(\"system\",\"x86_64-linux\")])"

Types

data Derivation

A Nix derivation

Constructors

Derivation

Fields

• outputs :: Map Text DerivationOutput

  Outputs produced by this derivation where keys are output names

• inputDrvs :: Map FilePath (Set Text)

  Inputs that are derivations where keys specify derivation paths and values specify which output names are used by this derivation

• inputSrcs :: Set FilePath

  Inputs that are sources

• platform :: Text

  Platform required for this derivation

• builder :: Text

  Code to build the derivation, which can be a path or a builtin function

• args :: Vector Text

  Arguments passed to the executable used to build to derivation

• env :: Map Text Text

  Environment variables provided to the executable used to build the derivation

Instances

Eq Derivation

Methods

(==) :: Derivation -> Derivation -> Bool

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

Ord Derivation

Methods

compare :: Derivation -> Derivation -> Ordering

(<) :: Derivation -> Derivation -> Bool

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

(>) :: Derivation -> Derivation -> Bool

(>=) :: Derivation -> Derivation -> Bool

max :: Derivation -> Derivation -> Derivation

min :: Derivation -> Derivation -> Derivation

Show Derivation

Methods

showsPrec :: Int -> Derivation -> ShowS

show :: Derivation -> String

showList :: [Derivation] -> ShowS

Generic Derivation

Associated Types

type Rep Derivation :: * -> *

Methods

from :: Derivation -> Rep Derivation x

to :: Rep Derivation x -> Derivation

NFData Derivation

Methods

rnf :: Derivation -> ()

type Rep Derivation

type Rep Derivation = D1 (MetaData "Derivation" "Nix.Derivation.Types" "nix-derivation-1.0.0-7M4IlC5G7LV8BMRiPz7A6y" False) (C1 (MetaCons "Derivation" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "outputs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Text DerivationOutput))) ((:*:) (S1 (MetaSel (Just Symbol "inputDrvs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map FilePath (Set Text)))) (S1 (MetaSel (Just Symbol "inputSrcs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Set FilePath))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "platform") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "builder") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "args") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Vector Text))) (S1 (MetaSel (Just Symbol "env") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map Text Text)))))))

data DerivationOutput

An output of a Nix derivation

Constructors

DerivationOutput

Fields

• path :: FilePath

  Path where the output will be saved

• hashAlgo :: Text

  Hash used for expected hash computation

• hash :: Text

  Expected hash

Instances

Eq DerivationOutput

Methods

(==) :: DerivationOutput -> DerivationOutput -> Bool

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

Ord DerivationOutput

Methods

compare :: DerivationOutput -> DerivationOutput -> Ordering

(<) :: DerivationOutput -> DerivationOutput -> Bool

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

(>) :: DerivationOutput -> DerivationOutput -> Bool

(>=) :: DerivationOutput -> DerivationOutput -> Bool

max :: DerivationOutput -> DerivationOutput -> DerivationOutput

min :: DerivationOutput -> DerivationOutput -> DerivationOutput

Show DerivationOutput

Methods

showsPrec :: Int -> DerivationOutput -> ShowS

show :: DerivationOutput -> String

showList :: [DerivationOutput] -> ShowS

Generic DerivationOutput

Associated Types

type Rep DerivationOutput :: * -> *

Methods

from :: DerivationOutput -> Rep DerivationOutput x

to :: Rep DerivationOutput x -> DerivationOutput

NFData DerivationOutput

Methods

rnf :: DerivationOutput -> ()

type Rep DerivationOutput

type Rep DerivationOutput = D1 (MetaData "DerivationOutput" "Nix.Derivation.Types" "nix-derivation-1.0.0-7M4IlC5G7LV8BMRiPz7A6y" False) (C1 (MetaCons "DerivationOutput" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "path") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) ((:*:) (S1 (MetaSel (Just Symbol "hashAlgo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) (S1 (MetaSel (Just Symbol "hash") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))))

Parse derivations

parseDerivation :: Parser Derivation

Parse a derivation

Render derivations

buildDerivation :: Derivation -> Builder

Render a derivation as a Builder