Expand description
§lumi
lumi is a double-entry accounting tool, and a library for parsing text-based ledger files.
Modules§
- parse
- Parsing input text files and generating valid a
Ledger. - utils
- Useful functions for parsing and accounting.
- web
Structs§
- Account
Info - Contains the open/close date of an account, as well as the notes and documents.
- Account
Note - Represents a
notedirective - Amount
- A
Decimalnumber plus the currency. - Error
- Contains the full information of an error.
- Event
Info - Represents an
eventdirective. - Ledger
- Represents a valid ledger containing all valid accounts and balanced transactions.
- Location
- Representing a location, line number and column number, in a source file.
- Posting
- A posting like
Assets::Bank -100 JPYinside aTransaction. - Source
- Represents a range in a source file. This struct is used to track the origins
of any information in the generated
Ledger, as well as for locating errors. - Transaction
- Represents a transaction, or a
paddirectives, or abalancedirective in the source file. - Unit
Cost - The cost basis information (unit cost and transaction date) used to identify a position in the running balances.
Enums§
- Error
Level - The level of an error. Any information in the source file resulting an
ErrorLevel::Errorare dropped. - Error
Type - Kinds of errors that
lumiencountered during generatingLedgerfrom files input text. - TxnFlag
- The flag of a
Transaction.
Type Aliases§
- Account
- A string wrapped in
Arcrepresenting the account name. - Account
Doc - Represents a
documentdirective - Balance
Sheet - Represents the final balances of all accounts.
- Currency
- Link
- Meta
- Represents the meta data attached to a commodity, a transaction, or a posting.
- Narration
- Payee
- Price
- The unit price.
- SrcFile
- A string wrapped in
Arcrepresenting the source file path. - Tag