Nix.Effects

Documentation

newtype StorePath

A path into the nix store

Constructors

StorePath Path

Instances

Convertible e t f m => ToValue StorePath m (NValue' t f m (NValue t f m))

Defined in Nix.Convert

Methods

toValue :: StorePath -> m (NValue' t f m (NValue t f m))

class MonadEffects t f m

class (MonadFile m, MonadStore m, MonadPutStr m, MonadHttp m, MonadEnv m, MonadPaths m, MonadInstantiate m, MonadExec m, MonadIntrospect m) => MonadEffects t f m where

Methods

toAbsolutePath :: Path -> m Path

Determine the absolute path in the current context.

findEnvPath :: String -> m Path

findPath :: [NValue t f m] -> Path -> m Path

Having an explicit list of sets corresponding to the NIX_PATH and a file path try to find an existing path.

importPath :: Path -> m (NValue t f m)

pathToDefaultNix :: Path -> m Path

derivationStrict :: NValue t f m -> m (NValue t f m)

traceEffect :: String -> m ()

Instances

(MonadEffects t f m, MonadDataContext f m) => MonadEffects t f (StdIdT m)

Defined in Nix.Fresh.Basic

Methods

toAbsolutePath :: Path -> StdIdT m Path

findEnvPath :: String -> StdIdT m Path

findPath :: [NValue t f (StdIdT m)] -> Path -> StdIdT m Path

importPath :: Path -> StdIdT m (NValue t f (StdIdT m))

pathToDefaultNix :: Path -> StdIdT m Path

derivationStrict :: NValue t f (StdIdT m) -> StdIdT m (NValue t f (StdIdT m))

traceEffect :: String -> StdIdT m ()

(MonadFix m, MonadFile m, MonadCatch m, MonadEnv m, MonadPaths m, MonadExec m, MonadHttp m, MonadInstantiate m, MonadIntrospect m, MonadPlus m, MonadPutStr m, MonadStore m, MonadAtomicRef m, Typeable m, Scoped (StdValue m) m, MonadReader (Context m (StdValue m)) m, MonadState (HashMap Path NExprLoc, HashMap Text Text) m, MonadDataErrorContext (StdThunk m) (StdCited m) m, MonadThunk (StdThunk m) m (StdValue m), MonadValue (StdValue m) m) => MonadEffects (StdThunk m) (StdCited m) m

Defined in Nix.Standard

Methods

toAbsolutePath :: Path -> m Path

findEnvPath :: String -> m Path

findPath :: [NValue (StdThunk m) (StdCited m) m] -> Path -> m Path

importPath :: Path -> m (NValue (StdThunk m) (StdCited m) m)

pathToDefaultNix :: Path -> m Path

derivationStrict :: NValue (StdThunk m) (StdCited m) m -> m (NValue (StdThunk m) (StdCited m) m)

traceEffect :: String -> m ()

Instances

class MonadIntrospect m

class Monad m => MonadIntrospect m where

Minimal complete definition

Nothing

Methods

recursiveSize :: a -> m Word

default recursiveSize :: (MonadTrans t, MonadIntrospect m', m ~ t m') => a -> m Word

Instances

MonadIntrospect IO

Defined in Nix.Effects

Methods

recursiveSize :: a -> IO Word

MonadIntrospect m => MonadIntrospect (StdIdT m)

Defined in Nix.Fresh.Basic

Methods

recursiveSize :: a -> StdIdT m Word

MonadIntrospect (t (Fix1 t)) => MonadIntrospect (Fix1 t)

Defined in Nix.Effects

Methods

recursiveSize :: a -> Fix1 t Word

(MonadIntrospect r, MonadIntrospect m) => MonadIntrospect (StandardTF r m)

Defined in Nix.Standard

Methods

recursiveSize :: a -> StandardTF r m Word

MonadIntrospect (t (Fix1T t m) m) => MonadIntrospect (Fix1T t m)

Defined in Nix.Effects

Methods

recursiveSize :: a -> Fix1T t m Word

Instances

class MonadExec m

class Monad m => MonadExec m where

Minimal complete definition

Nothing

Methods

exec' :: [Text] -> m (Either ErrorCall NExprLoc)

default exec' :: (MonadTrans t, MonadExec m', m ~ t m') => [Text] -> m (Either ErrorCall NExprLoc)

Instances

MonadExec IO

Defined in Nix.Effects

Methods

exec' :: [Text] -> IO (Either ErrorCall NExprLoc)

MonadExec m => MonadExec (StdIdT m)

Defined in Nix.Fresh.Basic

Methods

exec' :: [Text] -> StdIdT m (Either ErrorCall NExprLoc)

MonadExec (t (Fix1 t)) => MonadExec (Fix1 t)

Defined in Nix.Effects

Methods

exec' :: [Text] -> Fix1 t (Either ErrorCall NExprLoc)

(MonadExec r, MonadExec m) => MonadExec (StandardTF r m)

Defined in Nix.Standard

Methods

exec' :: [Text] -> StandardTF r m (Either ErrorCall NExprLoc)

MonadExec (t (Fix1T t m) m) => MonadExec (Fix1T t m)

Defined in Nix.Effects

Methods

exec' :: [Text] -> Fix1T t m (Either ErrorCall NExprLoc)

Instances

class MonadInstantiate m

class Monad m => MonadInstantiate m where

Minimal complete definition

Nothing

Methods

instantiateExpr :: Text -> m (Either ErrorCall NExprLoc)

default instantiateExpr :: (MonadTrans t, MonadInstantiate m', m ~ t m') => Text -> m (Either ErrorCall NExprLoc)

Instances

MonadInstantiate IO

Defined in Nix.Effects

Methods

instantiateExpr :: Text -> IO (Either ErrorCall NExprLoc)

MonadInstantiate m => MonadInstantiate (StdIdT m)

Defined in Nix.Fresh.Basic

Methods

instantiateExpr :: Text -> StdIdT m (Either ErrorCall NExprLoc)

MonadInstantiate (t (Fix1 t)) => MonadInstantiate (Fix1 t)

Defined in Nix.Effects

Methods

instantiateExpr :: Text -> Fix1 t (Either ErrorCall NExprLoc)

(MonadInstantiate r, MonadInstantiate m) => MonadInstantiate (StandardTF r m)

Defined in Nix.Standard

Methods

instantiateExpr :: Text -> StandardTF r m (Either ErrorCall NExprLoc)

MonadInstantiate (t (Fix1T t m) m) => MonadInstantiate (Fix1T t m)

Defined in Nix.Effects

Methods

instantiateExpr :: Text -> Fix1T t m (Either ErrorCall NExprLoc)

Instances

class MonadEnv m

class Monad m => MonadEnv m where

Minimal complete definition

Nothing

Methods

getEnvVar :: Text -> m (Maybe Text)

default getEnvVar :: (MonadTrans t, MonadEnv m', m ~ t m') => Text -> m (Maybe Text)

getCurrentSystemOS :: m Text

default getCurrentSystemOS :: (MonadTrans t, MonadEnv m', m ~ t m') => m Text

getCurrentSystemArch :: m Text

default getCurrentSystemArch :: (MonadTrans t, MonadEnv m', m ~ t m') => m Text

Instances

MonadEnv IO

Defined in Nix.Effects

Methods

getEnvVar :: Text -> IO (Maybe Text)

getCurrentSystemOS :: IO Text

getCurrentSystemArch :: IO Text

MonadEnv m => MonadEnv (StdIdT m)

Defined in Nix.Fresh.Basic

Methods

getEnvVar :: Text -> StdIdT m (Maybe Text)

getCurrentSystemOS :: StdIdT m Text

getCurrentSystemArch :: StdIdT m Text

MonadEnv (t (Fix1 t)) => MonadEnv (Fix1 t)

Defined in Nix.Effects

Methods

getEnvVar :: Text -> Fix1 t (Maybe Text)

getCurrentSystemOS :: Fix1 t Text

getCurrentSystemArch :: Fix1 t Text

(MonadEnv r, MonadEnv m) => MonadEnv (StandardTF r m)

Defined in Nix.Standard

Methods

getEnvVar :: Text -> StandardTF r m (Maybe Text)

getCurrentSystemOS :: StandardTF r m Text

getCurrentSystemArch :: StandardTF r m Text

MonadEnv (t (Fix1T t m) m) => MonadEnv (Fix1T t m)

Defined in Nix.Effects

Methods

getEnvVar :: Text -> Fix1T t m (Maybe Text)

getCurrentSystemOS :: Fix1T t m Text

getCurrentSystemArch :: Fix1T t m Text

Instances

class MonadPaths m

class Monad m => MonadPaths m where

Minimal complete definition

Nothing

Methods

getDataDir :: m Path

default getDataDir :: (MonadTrans t, MonadPaths m', m ~ t m') => m Path

Instances

MonadPaths IO

Defined in Nix.Effects

Methods

getDataDir :: IO Path

MonadPaths m => MonadPaths (StdIdT m)

Defined in Nix.Fresh.Basic

Methods

getDataDir :: StdIdT m Path

MonadPaths (t (Fix1 t)) => MonadPaths (Fix1 t)

Defined in Nix.Effects

Methods

getDataDir :: Fix1 t Path

(MonadPaths r, MonadPaths m) => MonadPaths (StandardTF r m)

Defined in Nix.Standard

Methods

getDataDir :: StandardTF r m Path

MonadPaths (t (Fix1T t m) m) => MonadPaths (Fix1T t m)

Defined in Nix.Effects

Methods

getDataDir :: Fix1T t m Path

Instances

class MonadHttp m

class Monad m => MonadHttp m where

Minimal complete definition

Nothing

Methods

getURL :: Text -> m (Either ErrorCall StorePath)

default getURL :: (MonadTrans t, MonadHttp m', m ~ t m') => Text -> m (Either ErrorCall StorePath)

Instances

MonadHttp IO

Defined in Nix.Effects

Methods

getURL :: Text -> IO (Either ErrorCall StorePath)

MonadHttp m => MonadHttp (StdIdT m)

Defined in Nix.Fresh.Basic

Methods

getURL :: Text -> StdIdT m (Either ErrorCall StorePath)

MonadHttp (t (Fix1 t)) => MonadHttp (Fix1 t)

Defined in Nix.Effects

Methods

getURL :: Text -> Fix1 t (Either ErrorCall StorePath)

(MonadHttp r, MonadHttp m) => MonadHttp (StandardTF r m)

Defined in Nix.Standard

Methods

getURL :: Text -> StandardTF r m (Either ErrorCall StorePath)

MonadHttp (t (Fix1T t m) m) => MonadHttp (Fix1T t m)

Defined in Nix.Effects

Methods

getURL :: Text -> Fix1T t m (Either ErrorCall StorePath)

Instances

class MonadPutStr m

class (Monad m, MonadIO m) => MonadPutStr m where

Minimal complete definition

Nothing

Methods

putStr :: String -> m ()

default putStr :: (MonadTrans t, MonadPutStr m', m ~ t m') => String -> m ()

Instances

MonadPutStr IO

Defined in Nix.Effects

Methods

putStr :: String -> IO ()

MonadPutStr m => MonadPutStr (StdIdT m)

Defined in Nix.Fresh.Basic

Methods

putStr :: String -> StdIdT m ()

MonadPutStr (t (Fix1 t)) => MonadPutStr (Fix1 t)

Defined in Nix.Effects

Methods

putStr :: String -> Fix1 t ()

(MonadPutStr r, MonadPutStr m) => MonadPutStr (StandardTF r m)

Defined in Nix.Standard

Methods

putStr :: String -> StandardTF r m ()

MonadPutStr (t (Fix1T t m) m) => MonadPutStr (Fix1T t m)

Defined in Nix.Effects

Methods

putStr :: String -> Fix1T t m ()

Instances

Functions

putStrLn :: MonadPutStr m => String -> m ()

print :: (MonadPutStr m, Show a) => a -> m ()

Store effects

Data type synonyms

type RecursiveFlag = Bool

type RepairFlag = Bool

type StorePathName = Text

type PathFilter m = Path -> m Bool

type StorePathSet = HashSet StorePath

class MonadStore m

class Monad m => MonadStore m where

Minimal complete definition

Nothing

Methods

addToStore :: StorePathName -> Path -> RecursiveFlag -> RepairFlag -> m (Either ErrorCall StorePath)

Copy the contents of a local path to the store. The resulting store path is returned. Note: This does not support yet support the expected filter function that allows excluding some files.

default addToStore :: (MonadTrans t, MonadStore m', m ~ t m') => StorePathName -> Path -> RecursiveFlag -> RepairFlag -> m (Either ErrorCall StorePath)

addTextToStore' :: StorePathName -> Text -> StorePathSet -> RepairFlag -> m (Either ErrorCall StorePath)

Like addToStore, but the contents written to the output path is a regular file containing the given string.

default addTextToStore' :: (MonadTrans t, MonadStore m', m ~ t m') => StorePathName -> Text -> StorePathSet -> RepairFlag -> m (Either ErrorCall StorePath)

Instances

MonadStore IO

Defined in Nix.Effects

Methods

addToStore :: StorePathName -> Path -> RecursiveFlag -> RepairFlag -> IO (Either ErrorCall StorePath)

addTextToStore' :: StorePathName -> Text -> StorePathSet -> RepairFlag -> IO (Either ErrorCall StorePath)

MonadStore m => MonadStore (StdIdT m)

Defined in Nix.Fresh.Basic

Methods

addToStore :: StorePathName -> Path -> RecursiveFlag -> RepairFlag -> StdIdT m (Either ErrorCall StorePath)

addTextToStore' :: StorePathName -> Text -> StorePathSet -> RepairFlag -> StdIdT m (Either ErrorCall StorePath)

(MonadFix1T t m, MonadStore m) => MonadStore (Fix1T t m)

Defined in Nix.Effects

Methods

addToStore :: StorePathName -> Path -> RecursiveFlag -> RepairFlag -> Fix1T t m (Either ErrorCall StorePath)

addTextToStore' :: StorePathName -> Text -> StorePathSet -> RepairFlag -> Fix1T t m (Either ErrorCall StorePath)

Instances

Functions

parseStoreResult :: Monad m => Text -> (Either String a, [Logger]) -> m (Either ErrorCall a)

addTextToStore :: (Framed e m, MonadStore m) => StorePathName -> Text -> StorePathSet -> RepairFlag -> m StorePath

addPath :: (Framed e m, MonadStore m) => Path -> m StorePath

Add Path into the Nix Store

toFile_ :: (Framed e m, MonadStore m) => Path -> Text -> m StorePath