Foreign.Nix.Shellout.Types

Store paths

newtype StorePath a

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

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.

NixAction

runNixAction :: RunOptions m -> NixAction e m a -> m (Either (NixActionError e) a)

Run a NixAction, given runtime options. See defaultRunOptions.

newtype NixAction e m a

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

Constructors

NixAction

Fields

• unNixAction :: ReaderT (RunOptions m) (ExceptT (NixActionError e) m) a

Instances

MonadTrans (NixAction e)

Defined in Foreign.Nix.Shellout.Types

Methods

lift :: Monad m => m a -> NixAction e m a

Monad m => MonadReader (RunOptions m) (NixAction e m)

Defined in Foreign.Nix.Shellout.Types

Methods

ask :: NixAction e m (RunOptions m)

local :: (RunOptions m -> RunOptions m) -> NixAction e m a -> NixAction e m a

reader :: (RunOptions m -> a) -> NixAction e m a

Monad m => MonadError (NixActionError e) (NixAction e m)

Defined in Foreign.Nix.Shellout.Types

Methods

throwError :: NixActionError e -> NixAction e m a

catchError :: NixAction e m a -> (NixActionError e -> NixAction e m a) -> NixAction e m a

Monad m => Monad (NixAction e m)

Defined in Foreign.Nix.Shellout.Types

Methods

(>>=) :: NixAction e m a -> (a -> NixAction e m b) -> NixAction e m b

(>>) :: NixAction e m a -> NixAction e m b -> NixAction e m b

return :: a -> NixAction e m a

Functor m => Functor (NixAction e m)

Defined in Foreign.Nix.Shellout.Types

Methods

fmap :: (a -> b) -> NixAction e m a -> NixAction e m b

(<$) :: a -> NixAction e m b -> NixAction e m a

Monad m => Applicative (NixAction e m)

Defined in Foreign.Nix.Shellout.Types

Methods

pure :: a -> NixAction e m a

(<*>) :: NixAction e m (a -> b) -> NixAction e m a -> NixAction e m b

liftA2 :: (a -> b -> c) -> NixAction e m a -> NixAction e m b -> NixAction e m c

(*>) :: NixAction e m a -> NixAction e m b -> NixAction e m b

(<*) :: NixAction e m a -> NixAction e m b -> NixAction e m a

MonadIO m => MonadIO (NixAction e m)

Defined in Foreign.Nix.Shellout.Types

Methods

liftIO :: IO a -> NixAction e m a

data RunOptions m

Options that modify how a NixAction executes.

Might get more fields in the future, use defaultRunOptions to be backwards-compatbile.

Constructors

RunOptions

Fields

• logFn :: LogFn m

  The command line logging function.

• executables :: Executables

  A record of all executables this library could need.

Instances

Monad m => MonadReader (RunOptions m) (NixAction e m)

Defined in Foreign.Nix.Shellout.Types

Methods

ask :: NixAction e m (RunOptions m)

local :: (RunOptions m -> RunOptions m) -> NixAction e m a -> NixAction e m a

reader :: (RunOptions m -> a) -> NixAction e m a

defaultRunOptions :: Monad m => RunOptions m

logFn = nothing is done/logged
executable = all executables are taken from PATH

newtype LogFn m

Logging function to call before running a command. This can be used to provide debugging output.

The first argument is the executable name, the second argument is the list of arguments.

Constructors

LogFn (Text -> [Text] -> m ())

data Executables

All executables this library might need.

If you set an executable to Just filepath, the internal code will use the given path instead of looking up the executable name in PATH. This is useful if you want to ensure that the executables always exist before calling into this library.

NixAction functions document the executables they use in their docstrings.

If an executable can’t be found, an IOException is thrown (by the process spawn function).

Constructors

Executables

Fields

• exeNixInstantiate :: Maybe FilePath

  nix-instantiate; usually you can expect nix to exist on the system (but we don’t check before running the commands)

• exeNixStore :: Maybe FilePath

  nix-store

• exeNixPrefetchUrl :: Maybe FilePath

  nix-prefetch-url; as of nix 2.3, this executable comes with the nix distribution, so if nix-store is available, this should also be available

• exeNixPrefetchGit :: Maybe FilePath

  nix-prefetch-git; This is usually provided by the nix-prefetch-scripts package and not installed with nix

defaultExecutables :: Executables

all executables are taken from PATH

data NixActionError e

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

Functor NixActionError

Defined in Foreign.Nix.Shellout.Types

Methods

fmap :: (a -> b) -> NixActionError a -> NixActionError b

(<$) :: a -> NixActionError b -> NixActionError a

Show e => Show (NixActionError e)

Defined in Foreign.Nix.Shellout.Types

Methods

showsPrec :: Int -> NixActionError e -> ShowS

show :: NixActionError e -> String

showList :: [NixActionError e] -> ShowS

Monad m => MonadError (NixActionError e) (NixAction e m)

Defined in Foreign.Nix.Shellout.Types

Methods

throwError :: NixActionError e -> NixAction e m a

catchError :: NixAction e m a -> (NixActionError e -> NixAction e m a) -> NixAction e m a

mapActionError :: Functor m => (a1 -> e) -> NixAction a1 m a2 -> NixAction e m a2

Map over the e in a NixActionError.