MIT licensed and maintained by Luis Pedro Coelho

Module documentation for 0.0.5.0

This version can be pinned in stack with:safeio-0.0.5.0@sha256:0d2437a3db8db8d5a59527ba050bf74757bbadb691d8ba40cf45d82b10e04654,1824

SafeIO: Haskell library for safe (atomic) IO

This is a simple module, which enables writing in atomic mode. It implements the following 4 step procedure:

  1. Open a temporary file in the same directory as the final output.
  2. Write to this temporary file.
  3. Close and sync the file.
  4. Atomically rename the file to its final destination.

Example

Direct use:

import System.IO.SafeWrite
...
main = do
    withOutputFile "output.txt" $ \hout -> do
        hPutStrLn hout "Hello World"

Through conduit:

import qualified Data.Conduit as C
import           Data.Conduit ((.|))
import           Data.Conduit.SafeWrite

main = C.runConduitRes $
    C.yield "Hello World" .| safeSinkFile "hello.txt"

In any case, only successful termination of the process will result in the output file being written. Early termination by throwing an exception will cause the temporary file to be removed and no output will be produced.

Author

Luis Pedro Coelho | Email | Twitter

comments powered byDisqus