RON.Storage.IO

A real-world file storage.

Typical usage:

import RON.Storage.IO as Storage

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

Documentation

module RON.Storage

Handle

data Handle

Storage handle (uses the “Handle pattern”).

newtype OnDocumentChanged

The handler is called as onDocumentChanged docid, where docid is the changed document id.

Constructors

OnDocumentChanged (forall a. Collection a => DocId a -> IO ())

newHandle :: FilePath -> IO Handle

Create new storage handle

setOnDocumentChanged :: Handle -> OnDocumentChanged -> IO ()

Storage

data Storage a

Environment is the dataDir

Instances

Monad Storage

Defined in RON.Storage.IO

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.IO

Methods

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

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

Applicative Storage

Defined in RON.Storage.IO

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.IO

Methods

liftIO :: IO a -> Storage a

ReplicaClock Storage

Defined in RON.Storage.IO

Methods

getPid :: Storage ReplicaId

getEvents :: EpochTime -> Storage [EpochEvent]

advance :: EpochTime -> Storage ()

MonadStorage Storage

Defined in RON.Storage.IO

Methods

getCollections :: Storage [CollectionName]

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

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

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

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

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

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

MonadError String Storage

Defined in RON.Storage.IO

Methods

throwError :: String -> Storage a

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

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

Run a Storage action