[][src]Module fin_model::reporting

Provides common types for reporting data.

Primarily this module provides the FinancialPeriod type that can represent periods such as "Q2 2019", "H1 2018", or "2020". This period may be used as a calendar period where the assumption is that the periods are relative to January 1st, or as a fiscal period where the start of a fiscal year may not align with calendar years. For this latter case the FiscalPeriod struct also contains a date for the fiscal year start.

The financial period type implements both fmt::Display and str::FromStr and so supports the ability to read and write the period as a string in a common manner.

Structs

FiscalPeriod

Represents a fiscal periods, with a reference start date, allowing it to represent years that do not align with the calendar start date.

Enums

FinancialPeriod

Represents common financial periods, whole years, half years, and quarter years.

ParseError

Errors that can result from parsing a FinancialPeriod from a string.