Macros§
Structs§
- Account
- Account
Analysis - Account
Analysis Builder - Builder for
AccountAnalysis. - Account
Analysis Flags - Account
Analysis Hooks - this lets us parametrize how we create the items we use to run the program
- Account
Analysis Hooks Builder - Builder for
AccountAnalysisHooks. - Account
Summary - Accounts
Config - Amazon
Config - if we provide this struct, we need all three fields.
- Amazon
Item Listing - Amazon
Store Business Purchase - Amazon
Store Business Purchase Builder - Builder for
AmazonStoreBusinessPurchase. - Amazon
Store Medical Purchase - Amazon
Store Medical Purchase Builder - Builder for
AmazonStoreMedicalPurchase. - Amazon
Tx - Amazon
Tx1 - this one is from the window 2009-2019
- Amazon
Tx2 - this one is from the window 2019-2023, after the first amazon account closing
- Amazon
TxBuilder - Builder for
AmazonTx. - Budget
- Represents a user’s budget plan for various categories and a given time period. Uses derive_builder to allow flexible instantiation.
- Budget
Builder - Builder for
Budget. - Budget
Comparison - Summarizes how actuals compare to a user’s budget for a category.
- Budget
Comparison Builder - Builder for
BudgetComparison. - Category
Map - Donation
- Donation
Builder - this is a factory class we use to create our Donation objects in various ways.
- Donation
Config - this is how we pass the configuration to our DonationBuilder
- Donation
Config Builder - Builder for
DonationConfig. - Donation
Value Estimate - Donation
Value Estimate Builder - Builder for
DonationValueEstimate. - Donations
Hooks - Donations
Hooks Builder - Builder for
DonationsHooks. - General
Config - Indexed
Amazon Tx - Mock
Transaction Category Array - Container to associate each enum variant with a datum.
- Multi
Year Summary - Aggregates data across multiple
Accounts spanning different years. Could be extended to unify them in one cohesive summary. - Program
Config - Quarterly
Summary - Summarizes totals over one calendar quarter.
For example, Q1 2023 or Q3 2024.
Tracks various transaction totals and counts across 3-month intervals. - Stemmed
Token - Transaction
- Transaction
Builder - A builder for constructing
Transactioninstances with optional fields. By default, it creates aV1transaction unless you call.version_v2(). - Transaction
Category Prediction - Year
Comparison - Stores differential data comparing two years.
Enums§
- Account
Analysis Builder Error - Error type for AccountAnalysisBuilder
- Account
Analysis Hooks Builder Error - Error type for AccountAnalysisHooksBuilder
- Account
Creation Error - Account
Error - Account
Kind - Amazon
Error - Amazon
Store Business Purchase Builder Error - Error type for AmazonStoreBusinessPurchaseBuilder
- Amazon
Store Medical Purchase Builder Error - Error type for AmazonStoreMedicalPurchaseBuilder
- Amazon
TxBuilder Error - Error type for AmazonTxBuilder
- Budget
Comparison Builder Error - Error type for BudgetComparisonBuilder
- Budget
Error - Domain-specific error conditions for budgeting.
No stringly-typed errors orunwrap()usage here. - Budget
Time Period - Example budgeting time period enum.
- Builder
Version - Whether we produce a V1 or V2 transaction.
- Categorized
Transactions Print Format - Donation
Builder Error - Donation
Config Builder Error - Error type for DonationConfigBuilder
- Donation
Location - Donation
Source - Donation
Type - Donation
Value Estimate Builder Error - Error type for DonationValueEstimateBuilder
- Donation
Value Estimate Format Strategy - Donations
Hooks Builder Error - Error type for DonationsHooksBuilder
- Mock
Transaction Category - Parse
CsvError - Quarter
Number - Enumerates which “quarter of year” a date belongs to.
- Quarterly
Error - Tracked
Year - Transaction
Builder Error - Transaction
File Read Error - Transaction
Type
Constants§
Traits§
- Account
Analysis Interface - Account
Interface - Amazon
Txn - Budgeting
- Defines the methods needed to compare an
Accountagainst aBudget. - Categorize
Transaction - Create
Quarterly Summary - Defines an interface for creating quarterly summaries (grouped by quarter).
If dates are invalid, returns a
QuarterlyError. - Differential
Analysis - GetAccount
Summary - GetAmazon
Store Business Purchase Category - GetAmazon
Store Medical Purchase Category - GetBalance
AtDate - GetCategory
Golden Csv - GetCheck
OrSerial Number - GetCheck
Transactions - GetCredit
Transactions - GetDebit
Transactions - GetDeposit
Transactions - GetDescription
- GetTotal
Checks - GetTotal
Credits - GetTotal
Debits - GetTotal
Deposits - GetTotal
Monetary Amount - GetTotal
Transaction Amount Within Dates - GetTransaction
Amount - GetTransaction
Date - GetTransaction
Posted Date - GetTransaction
Type - GetTransactions
ByKeyword - GetTransactions
OfType - GetTransactions
Over Price - GetTransactions
Under Price - GetTransactions
Within Dates - GetTransactions
Within Range - Medical
AndInsurance Categories - Pure
Business Expenditure Categories - Show
Account Bursts - Show
Account Summary - Show
Business Transactions - Show
Categorized Debug - Show
Categorized Short - Show
Category Map - Show
Histogram - Show
Medical AndInsurance Expenditures - Show
Monthly Summary - Show
Quarterly Summary - Show
Treasury Transactions AndChecks - Transaction
Category - Transaction
Interface - Treasury
AndChecks Categories - TryFrom
CsvContents - Unknown
- Year
ToDate
Functions§
- aggregate_
multi_ year - Summarizes multiple years or multiple
Accountinstances. - analyze_
amazon_ line_ items - analyze_
donations - analyze_
line_ items_ for_ account - build_
categorized_ transaction_ map - Builds the transaction-category map from
self.txns()using the knowncategory_map. - create_
amazon_ item_ map - might return None if we have no way to create it due to missing items in ProgramConfig
- estimate_
donation_ value - fuse_
amazon_ transactions_ from_ two_ epochs - load_
program_ config_ from_ path - maybe_
fuse_ amazon_ csv_ from_ two_ epochs - whether this does anything depends what we have in our config.toml
- mock_
example_ amazon_ business_ expenses - mock_
example_ amazon_ med_ expenses - mock_
example_ donations - parse_
amazon_ csv - post_
summary - predict_
category - print_
donations - print_
overall_ monthly_ aggregates - Prints all the final monthly aggregates, grouped by transaction type.
- print_
transaction_ lines - process_
single_ category_ block - Handles printing of a single category block and populates the average-monthly vectors.
- start_
of_ quarter - Returns the first day of the quarter for a given date as
Ok(NaiveDate), or returnsErr(QuarterlyError)if constructing the date is out of range. - total_
checks - total_
credits - total_
debits - total_
point_ of_ sale - transaction_
file_ contents - write_
to_ csv