Skip to content

HORIZON HASKELL Docs lts/ghc-10.0.x8fef28d2026-11-02Search packagesCtrl K

Theme: |

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02

Modulecriterion-1.6.5.0Haskell2010

Criterion.IO

Input and output actions.

Synopsis

value header
value headerRoot
value critVersion
value hGetRecords
value hPutRecords
value readRecords
value writeRecords
type ReportFileContents
value readJSONReports
value writeJSONReports

Packagecriterion-1.6.5.0
Exports10
LanguageHaskell2010
LicenceBSD-3-Clause
SourceIO.hs

valueheaderRoot :: String

The magic string we expect to start off the header.

valuecritVersion :: String

The current version of criterion, encoded into a string that is used in files.

valuehGetRecords :: Binary a => Handle -> IO (Either String [a])

Read all records from the given Handle.

valuehPutRecords :: Binary a => Handle -> [a] -> IO ()

Write records to the given Handle.

valuereadRecords :: Binary a => FilePath -> IO (Either String [a])

Read all records from the given file.

valuewriteRecords :: Binary a => FilePath -> [a] -> IO ()

Write records to the given file.

typetype ReportFileContents = (String, String, [Report])

On disk we store (name,version,reports), where version is the version of Criterion used to generate the file.

valuereadJSONReports :: FilePath -> IO (Either String ReportFileContents)

Alternative file IO with JSON instances. Read a list of reports from a .json file produced by criterion.

If the version does not match exactly, this issues a warning.

valuewriteJSONReports :: FilePath -> [Report] -> IO ()

Write a list of reports to a JSON file. Includes a header, which includes the current Criterion version number. This should be the inverse of readJSONReports.