Copyright	Profpatsch 2016–2018
License	GPL-3
Stability	experimental
Portability	nix 1.11.x, nix 2.0
Safe Haskell	None
Language	Haskell2010

Foreign.Nix.Shellout

Contents

Calling nix
Types

Description

Calls to the nix command line to convert textual nix expressions to derivations & realized storepaths.

Synopsis

parseNixExpr :: Text -> NixAction ParseError NixExpr
data ParseError
- = SyntaxError Text
- | UnknownParseError
instantiate :: NixExpr -> NixAction InstantiateError (StorePath Derivation)
data InstantiateError
- = NotADerivation
- | UnknownInstantiateError
eval :: NixExpr -> NixAction InstantiateError ()
realize :: StorePath Derivation -> NixAction RealizeError (StorePath Realized)
data RealizeError = UnknownRealizeError
addToStore :: FilePath -> NixAction RealizeError (StorePath Realized)
parseInstRealize :: Text -> NixAction NixError (StorePath Realized)
data NixError
newtype StorePath a = StorePath {
- unStorePath :: FilePath
}
data Derivation
data Realized
data NixExpr
runNixAction :: NixAction e a -> IO (Either (NixActionError e) a)
newtype NixAction e a = NixAction {
- unNixAction :: ExceptT (NixActionError e) IO a
}
data NixActionError e = NixActionError {
- actionStderr :: Text
- actionError :: e
}

Calling nix

Parse

parseNixExpr :: Text -> NixAction ParseError NixExpr Source #

Parse a nix expression and check for syntactic validity.

data ParseError Source #

Constructors

SyntaxError Text	the input string was not a syntactically valid nix expression
UnknownParseError	catch-all error

Instances

Instances details

Eq ParseError Source #
Instance details Defined in Foreign.Nix.Shellout Methods (==) :: ParseError -> ParseError -> Bool # (/=) :: ParseError -> ParseError -> Bool #
Show ParseError Source #
Instance details Defined in Foreign.Nix.Shellout Methods showsPrec :: Int -> ParseError -> ShowS # show :: ParseError -> String # showList :: [ParseError] -> ShowS #

Instantiate

instantiate :: NixExpr -> NixAction InstantiateError (StorePath Derivation) Source #

Instantiate a parsed expression into a derivation.

data InstantiateError Source #

Constructors

NotADerivation	the given expression does not evaluate to a derivaton
UnknownInstantiateError	catch-all error

Instances

Instances details

Eq InstantiateError Source #
Instance details Defined in Foreign.Nix.Shellout Methods (==) :: InstantiateError -> InstantiateError -> Bool # (/=) :: InstantiateError -> InstantiateError -> Bool #
Show InstantiateError Source #
Instance details Defined in Foreign.Nix.Shellout Methods showsPrec :: Int -> InstantiateError -> ShowS # show :: InstantiateError -> String # showList :: [InstantiateError] -> ShowS #

eval :: NixExpr -> NixAction InstantiateError () Source #

Just tests if the expression can be evaluated. That doesn’t mean it has to instantiate however.

Realize

realize :: StorePath Derivation -> NixAction RealizeError (StorePath Realized) Source #

Finally derivations are realized into full store outputs. This will typically take a while so it should be executed asynchronously.

data RealizeError Source #

Constructors

UnknownRealizeError

Instances

Instances details

Eq RealizeError Source #
Instance details Defined in Foreign.Nix.Shellout Methods (==) :: RealizeError -> RealizeError -> Bool # (/=) :: RealizeError -> RealizeError -> Bool #
Show RealizeError Source #
Instance details Defined in Foreign.Nix.Shellout Methods showsPrec :: Int -> RealizeError -> ShowS # show :: RealizeError -> String # showList :: [RealizeError] -> ShowS #

Helpers

addToStore :: FilePath -> NixAction RealizeError (StorePath Realized) Source #

Copy the given file or folder to the nix store and return it’s path.

parseInstRealize :: Text -> NixAction NixError (StorePath Realized) Source #

A convenience function to directly realize a nix expression. Any errors are put into a combined error type.

data NixError Source #

Combines all error types that could happen.

Constructors

ParseError ParseError
InstantiateError InstantiateError
RealizeError RealizeError

Instances

Instances details

Eq NixError Source #
Instance details Defined in Foreign.Nix.Shellout Methods (==) :: NixError -> NixError -> Bool # (/=) :: NixError -> NixError -> Bool #
Show NixError Source #
Instance details Defined in Foreign.Nix.Shellout Methods showsPrec :: Int -> NixError -> ShowS # show :: NixError -> String # showList :: [NixError] -> ShowS #

Types

newtype StorePath a Source #

A path in the nix store. It carries a phantom a to differentiate between Derivation files and Realized paths.

Constructors

StorePath
Fields unStorePath :: FilePath

Instances

Instances details

Eq (StorePath a) Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods (==) :: StorePath a -> StorePath a -> Bool # (/=) :: StorePath a -> StorePath a -> Bool #
Show (StorePath a) Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods showsPrec :: Int -> StorePath a -> ShowS # show :: StorePath a -> String # showList :: [StorePath a] -> ShowS #

data Derivation Source #

A nix derivation is a complete build instruction that can be realized.

data Realized Source #

Once a derivation is realized, the finished output can be used.

data NixExpr Source #

A sucessfully parsed nix expression.

Instances

Instances details

Show NixExpr Source #
Instance details Defined in Foreign.Nix.Shellout Methods showsPrec :: Int -> NixExpr -> ShowS # show :: NixExpr -> String # showList :: [NixExpr] -> ShowS #

runNixAction :: NixAction e a -> IO (Either (NixActionError e) a) Source #

Run a NixAction without having to go through ExceptT first.

newtype NixAction e a Source #

Calls a command that returns an error and the whole stderr on failure.

Constructors

NixAction
Fields unNixAction :: ExceptT (NixActionError e) IO a

Instances

Instances details

Bifunctor NixAction Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods bimap :: (a -> b) -> (c -> d) -> NixAction a c -> NixAction b d # first :: (a -> b) -> NixAction a c -> NixAction b c # second :: (b -> c) -> NixAction a b -> NixAction a c #
Monad (NixAction e) Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods (>>=) :: NixAction e a -> (a -> NixAction e b) -> NixAction e b # (>>) :: NixAction e a -> NixAction e b -> NixAction e b # return :: a -> NixAction e a #
Functor (NixAction e) Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods fmap :: (a -> b) -> NixAction e a -> NixAction e b # (<$) :: a -> NixAction e b -> NixAction e a #
Applicative (NixAction e) Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods pure :: a -> NixAction e a # (<>) :: NixAction e (a -> b) -> NixAction e a -> NixAction e b # liftA2 :: (a -> b -> c) -> NixAction e a -> NixAction e b -> NixAction e c # (>) :: NixAction e a -> NixAction e b -> NixAction e b # (<*) :: NixAction e a -> NixAction e b -> NixAction e a #
MonadIO (NixAction e) Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods liftIO :: IO a -> NixAction e a #

data NixActionError e Source #

Combines the standard error of running a command with a more semantic error type one should match on first.

Constructors

NixActionError
Fields actionStderr :: Text actionError :: e

Instances

Instances details

Functor NixActionError Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods fmap :: (a -> b) -> NixActionError a -> NixActionError b # (<$) :: a -> NixActionError b -> NixActionError a #
Show e => Show (NixActionError e) Source #
Instance details Defined in Foreign.Nix.Shellout.Types Methods showsPrec :: Int -> NixActionError e -> ShowS # show :: NixActionError e -> String # showList :: [NixActionError e] -> ShowS #