Modulehnix-0.17.0Haskell2010

Nix.Effects

7 types
9 classes
9 values

Packagehnix-0.17.0
Exports25
LanguageHaskell2010
LicenceBSD-3-Clause
SourceEffects.hs

newtypenewtype StorePath

A path into the nix store

Constructors

StorePath Path

Instances5Eq, Ord, Show, Hashable, ToValue

Eq StorePathDefined in hnix-0.17.0 · Nix.Effects
Ord StorePathDefined in hnix-0.17.0 · Nix.Effects
Show StorePathDefined in hnix-0.17.0 · Nix.Effects
Hashable StorePathDefined in hnix-0.17.0 · Nix.Effects
Convertible e t f m => ToValue StorePath m (NValue' t f m (NValue t f m))Defined in hnix-0.17.0 · Nix.Convert

`class MonadEffects t f m`

1 declaration

class

class (MonadFile m, MonadStore m, MonadPutStr m, MonadHttp m, MonadEnv m, MonadPaths m, MonadInstantiate m, MonadExec m, MonadIntrospect m) => MonadEffects t (f :: Type -> Type) (m :: Type -> Type) 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 ()

Instances2MonadEffects

(MonadEffects t f m, MonadDataContext f m) => MonadEffects t f (StdIdT m)Defined in hnix-0.17.0 · Nix.Fresh.Basic · orphan
(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) mDefined in hnix-0.17.0 · Nix.Standard

Instances

`class MonadIntrospect m`

1 declaration

classclass Monad m => MonadIntrospect (m :: Type -> Type) where

Methods

recursiveSize :: a -> m Word

Instances5MonadIntrospect

MonadIntrospect IODefined in hnix-0.17.0 · Nix.Effects
MonadIntrospect m => MonadIntrospect (StdIdT m)Defined in hnix-0.17.0 · Nix.Fresh.Basic · orphan
MonadIntrospect (t (Fix1 t)) => MonadIntrospect (Fix1 t)Defined in hnix-0.17.0 · Nix.Effects
(MonadIntrospect r, MonadIntrospect m) => MonadIntrospect (StandardTF r m)Defined in hnix-0.17.0 · Nix.Standard
MonadIntrospect (t (Fix1T t m) m) => MonadIntrospect (Fix1T t m)Defined in hnix-0.17.0 · Nix.Effects

Instances

`class MonadExec m`

1 declaration

classclass Monad m => MonadExec (m :: Type -> Type) where

Methods

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

Instances5MonadExec

MonadExec IODefined in hnix-0.17.0 · Nix.Effects
MonadExec m => MonadExec (StdIdT m)Defined in hnix-0.17.0 · Nix.Fresh.Basic · orphan
MonadExec (t (Fix1 t)) => MonadExec (Fix1 t)Defined in hnix-0.17.0 · Nix.Effects
(MonadExec r, MonadExec m) => MonadExec (StandardTF r m)Defined in hnix-0.17.0 · Nix.Standard
MonadExec (t (Fix1T t m) m) => MonadExec (Fix1T t m)Defined in hnix-0.17.0 · Nix.Effects

Instances

`class MonadInstantiate m`

1 declaration

classclass Monad m => MonadInstantiate (m :: Type -> Type) where

Methods

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

Instances5MonadInstantiate

MonadInstantiate IODefined in hnix-0.17.0 · Nix.Effects
MonadInstantiate m => MonadInstantiate (StdIdT m)Defined in hnix-0.17.0 · Nix.Fresh.Basic · orphan
MonadInstantiate (t (Fix1 t)) => MonadInstantiate (Fix1 t)Defined in hnix-0.17.0 · Nix.Effects
(MonadInstantiate r, MonadInstantiate m) => MonadInstantiate (StandardTF r m)Defined in hnix-0.17.0 · Nix.Standard
MonadInstantiate (t (Fix1T t m) m) => MonadInstantiate (Fix1T t m)Defined in hnix-0.17.0 · Nix.Effects

Instances

`class MonadEnv m`

1 declaration

classclass Monad m => MonadEnv (m :: Type -> Type) where

Methods

getEnvVar :: Text -> m (Maybe Text)
getCurrentSystemOS :: m Text
getCurrentSystemArch :: m Text

Instances5MonadEnv

MonadEnv IODefined in hnix-0.17.0 · Nix.Effects
MonadEnv m => MonadEnv (StdIdT m)Defined in hnix-0.17.0 · Nix.Fresh.Basic · orphan
MonadEnv (t (Fix1 t)) => MonadEnv (Fix1 t)Defined in hnix-0.17.0 · Nix.Effects
(MonadEnv r, MonadEnv m) => MonadEnv (StandardTF r m)Defined in hnix-0.17.0 · Nix.Standard
MonadEnv (t (Fix1T t m) m) => MonadEnv (Fix1T t m)Defined in hnix-0.17.0 · Nix.Effects

Instances

`class MonadPaths m`

1 declaration

classclass Monad m => MonadPaths (m :: Type -> Type) where

Methods

getDataDir :: m Path

Instances5MonadPaths

MonadPaths IODefined in hnix-0.17.0 · Nix.Effects
MonadPaths m => MonadPaths (StdIdT m)Defined in hnix-0.17.0 · Nix.Fresh.Basic · orphan
MonadPaths (t (Fix1 t)) => MonadPaths (Fix1 t)Defined in hnix-0.17.0 · Nix.Effects
(MonadPaths r, MonadPaths m) => MonadPaths (StandardTF r m)Defined in hnix-0.17.0 · Nix.Standard
MonadPaths (t (Fix1T t m) m) => MonadPaths (Fix1T t m)Defined in hnix-0.17.0 · Nix.Effects

Instances

`class MonadHttp m`

3 declarations

classclass Monad m => MonadHttp (m :: Type -> Type) where

Methods

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

Instances5MonadHttp

MonadHttp IODefined in hnix-0.17.0 · Nix.Effects
MonadHttp m => MonadHttp (StdIdT m)Defined in hnix-0.17.0 · Nix.Fresh.Basic · orphan
MonadHttp (t (Fix1 t)) => MonadHttp (Fix1 t)Defined in hnix-0.17.0 · Nix.Effects
(MonadHttp r, MonadHttp m) => MonadHttp (StandardTF r m)Defined in hnix-0.17.0 · Nix.Standard
MonadHttp (t (Fix1T t m) m) => MonadHttp (Fix1T t m)Defined in hnix-0.17.0 · Nix.Effects

valuebaseNameOf :: Text -> Text

valuetoStorePath :: StorePath -> StorePath

Instances

`class MonadPutStr m`

1 declaration

classclass (Monad m, MonadIO m) => MonadPutStr (m :: Type -> Type) where

Methods

putStr :: String -> m ()

Instances5MonadPutStr

MonadPutStr IODefined in hnix-0.17.0 · Nix.Effects
MonadPutStr m => MonadPutStr (StdIdT m)Defined in hnix-0.17.0 · Nix.Fresh.Basic · orphan
MonadPutStr (t (Fix1 t)) => MonadPutStr (Fix1 t)Defined in hnix-0.17.0 · Nix.Effects
(MonadPutStr r, MonadPutStr m) => MonadPutStr (StandardTF r m)Defined in hnix-0.17.0 · Nix.Standard
MonadPutStr (t (Fix1T t m) m) => MonadPutStr (Fix1T t m)Defined in hnix-0.17.0 · Nix.Effects

Instances

Functions

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

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

Store effects

0 declarations

Data type synonyms

typetype RecursiveFlag = Bool

typetype RepairFlag = Bool

typetype StorePathName = Text

typetype PathFilter (m :: Type -> Type) = Path -> m Bool

typetype StorePathSet = HashSet StorePath

`class MonadStore m`

datadata NarContent

Constructors

NarFile Path
NarText ByteString

valuetoNarSource :: MonadIO m => NarContent -> NarSource m

convert NarContent to NarSource needed in the store API

classclass Monad m => MonadStore (m :: Type -> Type) where

Methods

addToStore :: StorePathName -> NarContent -> RecursiveFlag -> RepairFlag -> m (Either ErrorCall StorePath)
Copy the contents of a local path(Or pure text) 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.
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.

Instances3MonadStore

MonadStore IODefined in hnix-0.17.0 · Nix.Effects
MonadStore m => MonadStore (StdIdT m)Defined in hnix-0.17.0 · Nix.Fresh.Basic · orphan
(MonadFix1T t m, MonadStore m) => MonadStore (Fix1T t m)Defined in hnix-0.17.0 · Nix.Effects

Instances

Functions

valueparseStoreResult

:: Monad m
=> Text
-> (Either RemoteStoreError a, loggers)
-> m (Either ErrorCall a)

valueaddTextToStore

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

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

Add Path into the Nix Store

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