RON.Storage

RON File Storage. For usage, see RON.Storage.IO.

Documentation

class (ReplicatedAsObject a, Typeable a) => Collection a where

A type that intended to be put in a separate collection must define a Collection instance.

Minimal complete definition

collectionName

Methods

collectionName :: CollectionName

fallbackParse :: MonadE m => UUID -> ByteStringL -> m (Object a)

Called when RON parser fails.

type CollectionName = FilePath

Collection (directory name)

newtype DocId a

Document identifier (directory name), should be a RON-Base32-encoded RON-UUID.

Constructors

DocId FilePath

Instances

Eq (DocId a)

Defined in RON.Storage

Methods

(==) :: DocId a -> DocId a -> Bool

(/=) :: DocId a -> DocId a -> Bool

Ord (DocId a)

Defined in RON.Storage

Methods

compare :: DocId a -> DocId a -> Ordering

(<) :: DocId a -> DocId a -> Bool

(<=) :: DocId a -> DocId a -> Bool

(>) :: DocId a -> DocId a -> Bool

(>=) :: DocId a -> DocId a -> Bool

max :: DocId a -> DocId a -> DocId a

min :: DocId a -> DocId a -> DocId a

Collection a => Show (DocId a)

Defined in RON.Storage

Methods

showsPrec :: Int -> DocId a -> ShowS

show :: DocId a -> String

showList :: [DocId a] -> ShowS

data Document a

Result of DB reading, loaded document with information about its versions

Constructors

Document

Fields

• value :: Object a

  Merged value.

• versions :: NonEmpty DocVersion
• isTouched :: IsTouched

Instances

Show (Document a)

Defined in RON.Storage

Methods

showsPrec :: Int -> Document a -> ShowS

show :: Document a -> String

showList :: [Document a] -> ShowS

type DocVersion = FilePath

Document version identifier (file name)

class (ReplicaClock m, MonadE m) => MonadStorage m where

Storage backend interface

Methods

getCollections :: m [CollectionName]

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

Must return [] for non-existent collection

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

Must return [] for non-existent document

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

Must create collection and document if not exist

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

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

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

Instances

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 -> 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 ()

createDocument :: (Collection a, MonadStorage m) => Object a -> m ()

Create document assuming it doesn't exist yet.

decodeDocId

Arguments

:: DocId a

-> Maybe (Bool, UUID)

Bool = is document id a valid UUID encoding

Try decode UUID from a file name

docIdFromUuid :: UUID -> DocId a

loadDocument :: (Collection a, MonadStorage m) => DocId a -> m (Document a)

Load all versions of a document

modify :: (Collection a, MonadStorage m) => DocId a -> StateT (Object a) m () -> m (Object a)

Load document, apply changes and put it back to storage

readVersion :: MonadStorage m => Collection a => DocId a -> DocVersion -> m (Object a, IsTouched)

Load document version as an object