Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Hledger.Read.InputOptions
Description
Various options to use when reading journal files. Similar to CliOptions.inputflags, simplifies the journal-reading functions.
Synopsis
- data InputOpts = InputOpts {
- mformat_ :: Maybe StorageFormat
- mrules_file_ :: Maybe FilePath
- aliases_ :: [String]
- anon_ :: Bool
- new_ :: Bool
- new_save_ :: Bool
- pivot_ :: String
- forecast_ :: Maybe DateSpan
- posting_account_tags_ :: Bool
- verbose_tags_ :: Bool
- reportspan_ :: DateSpan
- auto_ :: Bool
- infer_equity_ :: Bool
- infer_costs_ :: Bool
- balancingopts_ :: BalancingOpts
- strict_ :: Bool
- _defer :: Bool
- _ioDay :: Day
- class HasInputOpts c where
- inputOpts :: Lens' c InputOpts
- aliases :: Lens' c [String]
- anon__ :: Lens' c Bool
- auto__ :: Lens' c Bool
- balancingopts :: Lens' c BalancingOpts
- defer :: Lens' c Bool
- forecast :: Lens' c (Maybe DateSpan)
- infer_costs :: Lens' c Bool
- infer_equity :: Lens' c Bool
- ioDay :: Lens' c Day
- mformat :: Lens' c (Maybe StorageFormat)
- mrules_file :: Lens' c (Maybe FilePath)
- new__ :: Lens' c Bool
- new_save :: Lens' c Bool
- pivot :: Lens' c String
- posting_account_tags :: Lens' c Bool
- reportspan :: Lens' c DateSpan
- strict :: Lens' c Bool
- verbose_tags :: Lens' c Bool
- definputopts :: InputOpts
- forecastPeriod :: InputOpts -> Journal -> Maybe DateSpan
Types and helpers for input options
Constructors
InputOpts | |
Fields
|
Instances
class HasInputOpts c where Source #
Minimal complete definition
Methods
inputOpts :: Lens' c InputOpts Source #
aliases :: Lens' c [String] Source #
anon__ :: Lens' c Bool Source #
auto__ :: Lens' c Bool Source #
balancingopts :: Lens' c BalancingOpts Source #
defer :: Lens' c Bool Source #
forecast :: Lens' c (Maybe DateSpan) Source #
infer_costs :: Lens' c Bool Source #
infer_equity :: Lens' c Bool Source #
mformat :: Lens' c (Maybe StorageFormat) Source #
mrules_file :: Lens' c (Maybe FilePath) Source #
new__ :: Lens' c Bool Source #
new_save :: Lens' c Bool Source #
pivot :: Lens' c String Source #
posting_account_tags :: Lens' c Bool Source #
reportspan :: Lens' c DateSpan Source #
strict :: Lens' c Bool Source #
verbose_tags :: Lens' c Bool Source #
Instances
HasInputOpts InputOpts Source # | |
Defined in Hledger.Read.InputOptions Methods inputOpts :: Lens' InputOpts InputOpts Source # aliases :: Lens' InputOpts [String] Source # anon__ :: Lens' InputOpts Bool Source # auto__ :: Lens' InputOpts Bool Source # balancingopts :: Lens' InputOpts BalancingOpts Source # defer :: Lens' InputOpts Bool Source # forecast :: Lens' InputOpts (Maybe DateSpan) Source # infer_costs :: Lens' InputOpts Bool Source # infer_equity :: Lens' InputOpts Bool Source # ioDay :: Lens' InputOpts Day Source # mformat :: Lens' InputOpts (Maybe StorageFormat) Source # mrules_file :: Lens' InputOpts (Maybe FilePath) Source # new__ :: Lens' InputOpts Bool Source # new_save :: Lens' InputOpts Bool Source # pivot :: Lens' InputOpts String Source # posting_account_tags :: Lens' InputOpts Bool Source # reportspan :: Lens' InputOpts DateSpan Source # |
forecastPeriod :: InputOpts -> Journal -> Maybe DateSpan Source #
Get the Maybe the DateSpan to generate forecast options from. This begins on: - the start date supplied to the `--forecast` argument, if present - otherwise, the later of - the report start date if specified with -b-pdate: - the day after the latest normal (non-periodic) transaction in the journal, if any - otherwise today. It ends on: - the end date supplied to the `--forecast` argument, if present - otherwise the report end date if specified with -e-pdate: - otherwise 180 days (6 months) from today.