ReadonlyStoreEffects -> StoreEffects.

We can break out into readonly or binary cache or whatever later if need be.

Author: shlevy

hnix-store-core/README.md

@@ -3,7 +3,7 @@ hnix-store-core
 
 Core effects for interacting with the Nix store.
 
-See `ReadonlyStoreEffects` in [System.Nix.Store] for read-only
-operations on the store.
+See `StoreEffects` in [System.Nix.Store] for the available operations
+on the store.
 
 [System.Nix.Store]: ./src/System/Nix/Store.hs

hnix-store-core/src/System/Nix/Store.hs

@@ -7,7 +7,7 @@ Maintainer  : Shea Levy <[email protected]>
 module System.Nix.Store
   ( PathName, pathNameContents, pathName
   , PathHashAlgo, Path(..)
-  , ReadonlyStoreEffects(..)
+  , StoreEffects(..)
   , SubstitutablePathInfo(..)
   ) where
 
@@ -73,7 +73,7 @@ data SubstitutablePathInfo = SubstitutablePathInfo
     narSize :: !Integer
   }
 
--- | Read-only interactions with a store.
+-- | Interactions with the Nix store.
 --
 -- @rootedPath@: A path plus a witness to the fact that the path is
 -- reachable from a root whose liftime is at least as long as the
@@ -86,8 +86,8 @@ data SubstitutablePathInfo = SubstitutablePathInfo
 -- reference is held.
 --
 -- @m@: The monad the effects operate in.
-data ReadonlyStoreEffects rootedPath validPath m =
-  ReadonlyStoreEffects
+data StoreEffects rootedPath validPath m =
+  StoreEffects
     { -- | Project out the underlying 'Path' from a 'rootedPath'
       fromRootedPath :: !(rootedPath -> Path)
     , -- | Project out the underlying 'rootedPath' from a 'validPath'