RON.Storage.FS

A real-world file storage.

Typical usage:

import RON.Storage.FS as Storage

main = do
    let dataDir = "./data/"
    h <- Storage.newHandle dataDir
    runStorage h $ do
        obj <- newObjectState Note{active = True, text = "Write an example"}
        createDocument obj

Documentation

module RON.Storage

Handle

data Handle

Storage handle (uses the “Handle pattern”).

newHandle :: FilePath -> IO Handle

Create new storage handle. Uses MAC address for replica id or generates a random one.

newHandleWithReplicaId :: FilePath -> Word64 -> IO Handle

Storage

data Storage a

Environment is the dataDir

Instances

Monad Storage

Defined in RON.Storage.FS

Methods

(>>=) :: Storage a -> (a -> Storage b) -> Storage b

(>>) :: Storage a -> Storage b -> Storage b

return :: a -> Storage a

fail :: String -> Storage a

Functor Storage

Defined in RON.Storage.FS

Methods

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

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

Applicative Storage

Defined in RON.Storage.FS

Methods

pure :: a -> Storage a

(<*>) :: Storage (a -> b) -> Storage a -> Storage b

liftA2 :: (a -> b -> c) -> Storage a -> Storage b -> Storage c

(*>) :: Storage a -> Storage b -> Storage b

(<*) :: Storage a -> Storage b -> Storage a

MonadIO Storage

Defined in RON.Storage.FS

Methods

liftIO :: IO a -> Storage a

ReplicaClock Storage

Defined in RON.Storage.FS

Methods

getPid :: Storage ReplicaId

getEvents :: EpochTime -> Storage [EpochEvent]

advance :: EpochTime -> Storage ()

MonadStorage Storage

Defined in RON.Storage.FS

Methods

getCollections :: Storage [CollectionName]

getDocuments :: Collection a => Storage [DocId a]

getDocumentVersions :: Collection a => DocId a -> Storage [DocVersion]

saveVersionContent :: Collection a => DocId a -> DocVersion -> ByteStringL -> Storage ()

loadVersionContent :: Collection a => DocId a -> DocVersion -> Storage ByteStringL

deleteVersion :: Collection a => DocId a -> DocVersion -> Storage ()

changeDocId :: Collection a => DocId a -> DocId a -> Storage ()

MonadError Error Storage

Defined in RON.Storage.FS

Methods

throwError :: Error -> Storage a

catchError :: Storage a -> (Error -> Storage a) -> Storage a

runStorage :: Handle -> Storage a -> IO a

Run a Storage action

Listening to changes

type StopListening = IO ()

An action that cancels a watching/listening job

subscribe :: Handle -> IO (TChan (CollectionName, RawDocId))