merge
authorDon Stewart <dons@cse.unsw.edu.au>
Fri, 12 Jan 2007 13:09:08 +0000 (14:09 +0100)
committerDon Stewart <dons@cse.unsw.edu.au>
Fri, 12 Jan 2007 13:09:08 +0000 (14:09 +0100)
src/Data/Binary.hs
tests/Makefile

index 4b77703..aea5ba8 100644 (file)
@@ -165,11 +165,29 @@ decode = runGet get
 ------------------------------------------------------------------------
 -- Convenience IO operations
 
--- | Serialise a value to a file
+-- | Lazily serialise a value to a file
+--
+-- This is just a convenience function, it's defined simply as:
+--
+-- > encodeFile f = B.writeFile f . encode
+--
+-- So for example if you wanted to compress as well, you could use:
+--
+-- > B.writeFile f . compress . encode
+--
 encodeFile :: Binary a => FilePath -> a -> IO ()
 encodeFile f v = L.writeFile f (encode v)
 
--- | Reconstruct a value previously written to a file
+-- | Lazily reconstruct a value previously written to a file
+--
+-- This is just a convenience function, it's defined simply as:
+--
+-- > decodeFile f = return . decode =<< B.readFile f
+--
+-- So for example if you wanted to decompress as well, you could use:
+--
+-- > return . decode . decompress =<< B.readFile f
+--
 decodeFile :: Binary a => FilePath -> IO a
 decodeFile f = liftM decode (L.readFile f)
 
index 1917f69..b9bd264 100644 (file)
@@ -2,3 +2,6 @@ all:
        runhaskell QC.hs
        ghc --make -O -funbox-strict-fields QC.hs -o qc -no-recomp
        time ./qc
+
+clean:
+       rm -f *.o *.hi qc *~