Foreign.Nix.Shellout

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

Calling nix

Parse

parseNixExpr :: Text -> NixAction ParseError NixExpr

Parse a nix expression and check for syntactic validity.

data ParseError

Constructors

SyntaxError Text

the input string was not a syntactically valid nix expression

UnknownParseError

catch-all error

Instances

Eq ParseError

Defined in Foreign.Nix.Shellout

Methods

(==) :: ParseError -> ParseError -> Bool

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

Show ParseError

Defined in Foreign.Nix.Shellout

Methods

showsPrec :: Int -> ParseError -> ShowS

show :: ParseError -> String

showList :: [ParseError] -> ShowS

Instantiate

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

Instantiate a parsed expression into a derivation.

data InstantiateError

Constructors

NotADerivation

the given expression does not evaluate to a derivaton

UnknownInstantiateError

catch-all error

Instances

Eq InstantiateError

Defined in Foreign.Nix.Shellout

Methods

(==) :: InstantiateError -> InstantiateError -> Bool

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

Show InstantiateError

Defined in Foreign.Nix.Shellout

Methods

showsPrec :: Int -> InstantiateError -> ShowS

show :: InstantiateError -> String

showList :: [InstantiateError] -> ShowS

eval :: NixExpr -> NixAction InstantiateError ()

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)

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

data RealizeError

Constructors

UnknownRealizeError

Instances

Eq RealizeError

Defined in Foreign.Nix.Shellout

Methods

(==) :: RealizeError -> RealizeError -> Bool

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

Show RealizeError

Defined in Foreign.Nix.Shellout

Methods

showsPrec :: Int -> RealizeError -> ShowS

show :: RealizeError -> String

showList :: [RealizeError] -> ShowS

Helpers

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

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

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

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

data NixError

Combines all error types that could happen.

Constructors

ParseError ParseError

InstantiateError InstantiateError

RealizeError RealizeError

Instances

Eq NixError

Defined in Foreign.Nix.Shellout

Methods

(==) :: NixError -> NixError -> Bool

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

Show NixError

Defined in Foreign.Nix.Shellout

Methods

showsPrec :: Int -> NixError -> ShowS

show :: NixError -> String

showList :: [NixError] -> ShowS

Types

data StorePath a

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

Instances

Eq (StorePath a)

Defined in Foreign.Nix.Shellout.Types

Methods

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

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

Show (StorePath a)

Defined in Foreign.Nix.Shellout.Types

Methods

showsPrec :: Int -> StorePath a -> ShowS

show :: StorePath a -> String

showList :: [StorePath a] -> ShowS

data Derivation

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

data Realized

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

data NixExpr

A sucessfully parsed nix expression.

Instances

Eq NixExpr

Defined in Foreign.Nix.Shellout

Methods

(==) :: NixExpr -> NixExpr -> Bool

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

Show NixExpr

Defined in Foreign.Nix.Shellout

Methods

showsPrec :: Int -> NixExpr -> ShowS

show :: NixExpr -> String

showList :: [NixExpr] -> ShowS

runNixAction :: NixAction e a -> IO (Either (Text, e) a)

Run a NixAction without having to go through ExceptT first.

newtype NixAction e a

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

Constructors

NixAction

Fields

• unNixAction :: ExceptT (Text, e) IO a

Instances

Bifunctor NixAction

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)

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

fail :: String -> NixAction e a

Functor (NixAction e)

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)

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)

Defined in Foreign.Nix.Shellout.Types

Methods

liftIO :: IO a -> NixAction e a