Data.Git.Internal.FileUtil

Documentation

withHandle :: NFData a => Maybe FileMode -> OpenMode -> RawFilePath -> OpenFileFlags -> (Handle -> IO a) -> IO a

A somewhat more involved version of withFile.

withHandleAtomic :: NFData a => RawFilePath -> (Handle -> IO (Maybe RawFilePath, a)) -> IO a

Uses mkstemp (with the given path as the filename template) instead of the withHandle machinery to open the temp file. The awkward type in the callback is to let the user compute the name of the output file---when Just tgt, the temp file is renamed to tgt, otherwise we use the template.

data TempFile

An open temp file.

Constructors

TempFile

Fields

• tempHandle :: Handle
• tempFileName :: RawFilePath

  The filename mkstemp came up with.

• tempTemplate :: RawFilePath

  Template given to mkstemp for this file.

• closeTempFile :: Maybe RawFilePath -> IO ()

  When given Nothing, deletes the temp file, when given Just tgt, renames the temp file to tgt.

tempFile :: RawFilePath -> IO TempFile

Make a TempFile using the given RawFilePath as a template for mkstemp.

readFileFlags :: OpenFileFlags

Flags to open a file for reading

readRawFileL :: RawFilePath -> IO ByteString

Read a file into a lazy ByteString.

readRawFileS :: RawFilePath -> IO ByteString

Read a file into a strict ByteString.

writeRawFileL :: RawFilePath -> ByteString -> IO ()

Write a lazy ByteString to a file via withHandleAtomic.

writeRawFileS :: RawFilePath -> ByteString -> IO ()

Write a strict ByteString to a file via withHandleAtomic.

whenFileExists

Arguments

:: MonadIO m

=> RawFilePath

-> a

Return this when the file doesn't exist.

-> m a

Do this when it does.

-> m a

Do something when a file exists.

mwhenFileExists :: (MonadIO m, Alternative f) => RawFilePath -> m a -> m (f a)

Like whenFileExists, with empty as a default.

getRawDirectoryContents :: RawFilePath -> IO [RawFilePath]

Lists the files in a directory.

createRawDirectoryIfMissing :: Bool -> RawFilePath -> IO ()

This is stolen directly from createDirectoryIfMissing, swapped to use functions from FilePath. NB: due to the absence of a normalise function in the latter module, this function doesn't do any normalization.

withRawCurrentDirectory :: RawFilePath -> IO a -> IO a

A version of withCurrentDirectory using a RawFilePath.