Restless.Git

This module defines a simple way to serialize state as a nested file hierarchy saved in a Git repository.

Documentation

data Path

A fact path is something like "/0123...abc/storage/0x1". It has some number of directories and a file name.

Constructors

Path [ByteString] ByteString

Instances

Eq Path

Defined in Restless.Git

Methods

(==) :: Path -> Path -> Bool

(/=) :: Path -> Path -> Bool

Ord Path

Defined in Restless.Git

Methods

compare :: Path -> Path -> Ordering

(<) :: Path -> Path -> Bool

(<=) :: Path -> Path -> Bool

(>) :: Path -> Path -> Bool

(>=) :: Path -> Path -> Bool

max :: Path -> Path -> Path

min :: Path -> Path -> Path

Show Path

Defined in Restless.Git

Methods

showsPrec :: Int -> Path -> ShowS

show :: Path -> String

showList :: [Path] -> ShowS

data File

A file is a serialized value with a path.

Constructors

File

Fields

• filePath :: Path
• fileData :: ByteString

Instances

Eq File

Defined in Restless.Git

Methods

(==) :: File -> File -> Bool

(/=) :: File -> File -> Bool

Ord File

Defined in Restless.Git

Methods

compare :: File -> File -> Ordering

(<) :: File -> File -> Bool

(<=) :: File -> File -> Bool

(>) :: File -> File -> Bool

(>=) :: File -> File -> Bool

max :: File -> File -> File

min :: File -> File -> File

Show File

Defined in Restless.Git

Methods

showsPrec :: Int -> File -> ShowS

show :: File -> String

showList :: [File] -> ShowS

make :: (Monad m, MonadIO m) => FilePath -> m ()

Initialize an empty repository at the given path.

save :: (Monad m, MonadIO m) => FilePath -> Text -> Set File -> m ()

Save a set of files to an initialized repository and commit this tree to the master branch with a given commit message.

load :: (Monad m, MonadIO m) => FilePath -> m (Set File)

Load a set of files from a repository's master branch.