Hoogle Search
Within LTS Haskell 24.32 (ghc-9.10.3)
Note that Stackage only displays results for the latest LTS and Nightly snapshot. Learn more.
readDotFile :: ParseDotRepr dg n => FilePath -> IO (dg n)graphviz Data.GraphViz.Commands.IO Read in and parse a DotRepr value from a file.
readJsonFile :: FromJSON a => FilePath -> IO ahledger-lib Hledger.Data.Json Read a JSON file and decode it to the target type, or raise an error if we can't. Eg: readJsonFile "a.json" :: IO Transaction
readJournal :: InputOpts -> Maybe FilePath -> Handle -> ExceptT String IO Journalhledger-lib Hledger.Read readJournal iopts mfile txt
Read a Journal from some handle, with strict checks if enabled, or return an error message. The reader (data format) is chosen based on, in this order:- a reader name provided in iopts
- a reader prefix in the mfile path
- a file extension in mfile
readJournal' :: Handle -> IO Journalhledger-lib Hledger.Read An easy version of readJournal which assumes default options, and fails in the IO monad.
readJournal'' :: Text -> IO Journalhledger-lib Hledger.Read An even easier version of readJournal' which takes a Text instead of a Handle.
readJournalFile :: InputOpts -> PrefixedFilePath -> ExceptT String IO Journalhledger-lib Hledger.Read Read a Journal from this file, or from stdin if the file path is -, with strict checks if enabled, or return an error message. XXX or, calls error if the file does not exist. (Note strict checks are disabled temporarily here when this is called by readJournalFiles). The file path can have a READER: prefix. The reader (data format) to use is determined from (in priority order): the mformat_ specified in the input options, if any; the file path's READER: prefix, if any; a recognised file name extension. if none of these identify a known reader, the journal reader is used. The input options can also configure balance assertion checking, automated posting generation, a rules file for converting CSV data, etc. If using --new, and if latest-file writing is enabled in input options, and not deferred by readJournalFiles, and after passing strict checks if enabled, a .latest.FILE file will be created/updated (for the main file only, not for included files), to remember the latest transaction date processed.
readJournalFile' :: PrefixedFilePath -> IO Journalhledger-lib Hledger.Read An easy version of readJournalFile which assumes default options, and fails in the IO monad.
readJournalFiles :: InputOpts -> [PrefixedFilePath] -> ExceptT String IO Journalhledger-lib Hledger.Read Read a Journal from each specified file path (using readJournalFile) and combine them into one; or return the first error message. Combining Journals means concatenating them, basically. The parse state resets at the start of each file, which means that directives & aliases do not affect subsequent sibling or parent files. They do affect included child files though. Also the final parse state saved in the Journal does span all files. Strict checks, if enabled, are temporarily deferred until all files are read, to ensure they see the whole journal, and/or to avoid redundant work. (Some checks, like assertions and ordereddates, might still be doing redundant work ?) Writing .latest files, if enabled, is also deferred till the end, and is done only if strict checks pass.
readJournalFiles' :: [PrefixedFilePath] -> IO Journalhledger-lib Hledger.Read An easy version of readJournalFiles' which assumes default options, and fails in the IO monad.
-
hledger-lib Hledger.Read No documentation available.