Safe Haskell	Safe-Inferred
Language	GHC2021

HashAddressed.Directory

Contents

Type
Write operations

Synopsis

data Directory = Directory {
- directoryPath :: FilePath
- hashFunction :: HashFunction
}
writeLazy :: forall m. MonadIO m => Directory -> ByteString -> m WriteResult
writeStream :: forall commit m. MonadIO m => Directory -> Producer ByteString IO commit -> m (commit, WriteResult)
writeExcept :: forall abort commit m. (MonadIO m, MonadError abort m) => Directory -> Producer ByteString IO (Either abort commit) -> m (commit, WriteResult)
data WriteResult = WriteResult {
- hashAddressedFile :: FilePath
- writeType :: WriteType
}
data WriteType
- = AlreadyPresent
- | NewContent

Type

data Directory Source #

Specification of a hash-addressed directory

Note that the utilities in HashAddressed.Directory do not create the directory; ensure that it already exists before attempting to write.

See HashAddressed.HashFunction for examples of hash functions.

Constructors

Directory
Fields directoryPath :: FilePath Directory where hash-addressed files are stored hashFunction :: HashFunction Hash function to use for generating file names

Write operations

writeLazy Source #

Arguments

:: forall m. MonadIO m
=> Directory	Where to write
-> ByteString	What to write
-> m WriteResult

Write a lazy ByteString to a hash-addressed directory

This is a simplified variant of writeStream.

writeStream Source #

Arguments

:: forall commit m. MonadIO m
=> Directory	Where to write
-> Producer ByteString IO commit	What to write
-> m (commit, WriteResult)

Write a stream of strict ByteStrings to a hash-addressed directory

If the producer throws an exception, nothing will be written and the exception will be re-thrown.

This is a simplified variant of writeExcept.

writeExcept Source #

Arguments

:: forall abort commit m. (MonadIO m, MonadError abort m)
=> Directory	Where to write
-> Producer ByteString IO (Either abort commit)	What to write
-> m (commit, WriteResult)

Write a stream of strict ByteStrings to a hash-addressed directory, possibly aborting mid-stream with an error value instead

If the producer throws abort or an IO exception, nothing will be written. An abort thrown via ExceptT will be re-thrown via MonadError, and an exception thrown via IO will be re-thrown via IO.

data WriteResult Source #

Constructors

WriteResult
Fields hashAddressedFile :: FilePath The file path where the contents written by the action now reside, including the store directory writeType :: WriteType

data WriteType Source #

Constructors

AlreadyPresent	No action was taken because the content is already present in the directory
NewContent	A new file was written into the directory