Hoogle Search

Within LTS Haskell 24.50 (ghc-9.10.3)

Note that Stackage only displays results for the latest LTS and Nightly snapshot. Learn more.

Exact lookup

1. readJournalFile :: InputOpts -> PrefixedFilePath -> ExceptT String IO Journal

   hledger-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.

2. readJournalFile' :: PrefixedFilePath -> IO Journal

   hledger-lib	Hledger.Read

   An easy version of readJournalFile which assumes default options, and fails in the IO monad.

3. readJournalFiles :: InputOpts -> [PrefixedFilePath] -> ExceptT String IO Journal

   hledger-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.

4. readJournalFiles' :: [PrefixedFilePath] -> IO Journal

   hledger-lib	Hledger.Read

   An easy version of readJournalFiles' which assumes default options, and fails in the IO monad.

5. readJournalFilesAndLatestDates :: InputOpts -> [PrefixedFilePath] -> ExceptT String IO (Journal, [LatestDatesForFile])

   hledger-lib	Hledger.Read

   No documentation available.

6. reader :: forall (m :: Type -> Type) . MonadIO m => SepFormat -> Reader m

   hledger-lib	Hledger.Read.CsvReader

   No documentation available.

7. reader :: forall (m :: Type -> Type) . MonadIO m => Reader m

   hledger-lib	Hledger.Read.JournalReader

   No documentation available.

8. readJournalFromCsv :: Maybe (Either CsvRules FilePath) -> FilePath -> Handle -> Maybe SepFormat -> ExceptT String IO Journal

   hledger-lib	Hledger.Read.RulesReader

   Read a Journal from the given CSV data (and filename, used for error messages), or return an error. Proceed as follows:

   1. Conversion rules are provided, or they are parsed from the specified rules file, or from the default rules file for the CSV data file. If rules parsing fails, or the required rules file does not exist, throw an error.
   2. Parse the CSV data using the rules, or throw an error.
   3. Convert the CSV records to hledger transactions using the rules.
   4. Return the transactions as a Journal.

9. reader :: forall (m :: Type -> Type) . MonadIO m => Reader m

   hledger-lib	Hledger.Read.RulesReader

   No documentation available.

10. reader :: forall (m :: Type -> Type) . MonadIO m => Reader m

    hledger-lib	Hledger.Read.TimeclockReader

    No documentation available.

Page 203 of many | Previous | Next