Haskell implementation of the nix store API
Go to file
Richard Marko 5dc1802665 core: move Arbitrary instances near their types
This allows us to use them in remote serialization
round trip props.

Couple of them are not needed anymore (`NixLike` is the
default now) so whole `tests/Arbitrary` is gone.
2023-11-15 08:29:49 +01:00
.github CI: Switch to haskell-ci.dhall 2023-11-11 19:00:20 +01:00
hnix-store-core core: move Arbitrary instances near their types 2023-11-15 08:29:49 +01:00
hnix-store-remote remote: common - add RecordWildCards, ScopedTypeVariables 2023-11-15 08:29:49 +01:00
.envrc Lorri + direnv. 2019-03-19 20:52:25 -04:00
.gitignore cabal new gitignores. 2019-03-19 20:44:29 -04:00
cabal.project add cabal.project 2018-07-16 09:12:34 +02:00
cabal.project.local.ci CI: re-enable io-testsuite 2023-11-12 13:55:18 +01:00
core-simple.png treewide: use lift 2021-08-06 19:29:02 +03:00
default.nix defualt.nix: unpin 2023-11-12 14:23:02 +01:00
hie.yaml help HLSes determine the root of the project and the cradles 2021-02-09 00:12:02 +02:00
LICENSE Copyright 2018-04-24 09:34:16 -04:00
overlay.nix overlay.nix: refactor using pipe, add buildFromSdist 2023-11-15 07:51:30 +01:00
README.md README: Add badges 2023-11-13 08:25:26 +01:00
shell.nix shell.nix: pass cmdline arguments to default.nix 2023-11-11 19:00:21 +01:00

hnix-store

A Haskell interface to the Nix store.

Rationale

Nix can conceptually be broken up into two layers, both (perhaps unfortunately) named "Nix": The expression language and the store. The semantics of the expression language fundamentally depend on the store, but the store is independent of the language. The store semantics provide the basic building blocks of Nix: content-addressed files and directories, the drv file format and the semantics for building drvs, tracking references of store paths, copying files between stores (or to/from caches), distributed builds, etc.

The goal of hnix-store is to provide a Haskell interface to the Nix store semantics, as well as various implementations of that interface. Though the current primary client is hnix, an effort to reimplement the Nix expression language in Haskell, this project is meant to be generic and could be used for a number of other cases of interaction with the Nix store (e.g. a shake backend that emitted each build action as a store derivation). Currently, there are three implementations planned:

  • A mock store which performs no IO whatsoever, for unit testing.
  • A readonly store, which defers to another implementation for readonly effects (such as querying whether some path is valid in the store, or reading a file) but performs mutating effects in-memory only (for example, computing the store path a given directory would live at if added to the store, without actually modifying anything).
  • A remote store, which implements the client side of the Nix daemon Unix domain socket protocol, allowing full interaction with the store on a system with the C++ daemon installed.

Packages

In the interest of separating concerns, this project is split into several Haskell packages.

hnix-store-core

GitHub Workflow Status Hackage version Dependencies

Contains the core effect types and fundamental operations combining them, agnostic to any particular effectful implementation (e.g. in-memory, talking to the Nix daemon in IO, etc.), with the actual implementations in a different package.

The intent is that core business logic for a project that needs to interact with the Nix store can simply depend on hnix-store-core, and only at the very edges of the system would it be necessary to bring in a specific implementation.

hnix-store-remote

GitHub Workflow Status Hackage version Dependencies

Nix worker protocol implementation for interacting with remote Nix store via nix-daemon.