financial_api/types/
finance.rs1use std::str::FromStr;
2
3use serde::{Deserialize, Deserializer, Serialize};
4
5use super::wire::wire_enum;
6use crate::ValidationError;
7
8#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, derive_more::Display)]
10#[serde(transparent)]
11pub struct FinancialReport(String);
12
13impl FinancialReport {
14 pub fn parse(value: impl Into<String>) -> Result<Self, ValidationError> {
15 let value = value.into();
16 let bytes = value.as_bytes();
17 let valid = bytes.len() == 6
18 && bytes[..4].iter().all(u8::is_ascii_digit)
19 && bytes[4] == b'-'
20 && matches!(bytes[5], b'1'..=b'4');
21 if !valid {
22 return Err(ValidationError::new("report", "must use YYYY-[1-4] format"));
23 }
24 Ok(Self(value))
25 }
26
27 #[must_use]
28 pub fn as_str(&self) -> &str {
29 &self.0
30 }
31}
32
33impl FromStr for FinancialReport {
34 type Err = ValidationError;
35
36 fn from_str(value: &str) -> Result<Self, Self::Err> {
37 Self::parse(value)
38 }
39}
40
41impl AsRef<str> for FinancialReport {
42 fn as_ref(&self) -> &str {
43 self.as_str()
44 }
45}
46
47impl<'de> Deserialize<'de> for FinancialReport {
48 fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
49 let value = String::deserialize(deserializer)?;
50 Self::parse(value).map_err(serde::de::Error::custom)
51 }
52}
53
54wire_enum! {
55 pub enum FinancialPeriod {
57 Annual => "annual",
58 Quarterly => "quarterly",
59 }
60}
61
62wire_enum! {
63 pub enum FiscalPeriod {
65 FullYear => "FY",
66 FirstQuarter => "Q1",
67 SecondQuarter => "Q2",
68 ThirdQuarter => "Q3",
69 FourthQuarter => "Q4",
70 }
71}
72
73wire_enum! {
74 pub enum FinancialAbilityKind {
76 Growth => "growth",
77 Profitability => "profitability",
78 Solvency => "solvency",
79 Operation => "operation",
80 CashFlow => "cash-flow",
81 }
82}
83
84wire_enum! {
85 pub enum FinancialIndicatorId {
87 TotalAssetsGrowthRatio => "total_assets_growth_ratio",
88 NetProfitYoyGrowthRatio => "net_profit_yoy_growth_ratio",
89 #[serde(alias = "calculate_operating_income_yoy_growth_ratio")]
90 OperatingIncomeYoyGrowthRatio => "operating_income_yoy_growth_ratio",
91 #[serde(alias = "calculate_operating_profit_yoy_growth_ratio")]
92 OperatingProfitYoyGrowthRatio => "operating_profit_yoy_growth_ratio",
93 FixedAssetInvestExpansionRatio => "fixed_asset_invest_expansion_ratio",
94 #[serde(alias = "calculate_parent_holder_net_profit_yoy_growth_ratio")]
95 ParentHolderNetProfitYoyGrowthRatio => "parent_holder_net_profit_yoy_growth_ratio",
96 SaleGrossMargin => "sale_gross_margin",
97 SaleNetInterestRatio => "sale_net_interest_ratio",
98 TotalAssetsNetRatio => "total_assets_net_ratio",
99 DeductWeightedAverageReturnOnEquity => "index_deduct_weighted_avg_roe",
100 WeightedAverageReturnOnEquity => "index_weighted_avg_roe",
101 CurrentRatio => "current_ratio",
102 QuickRatio => "quick_ratio",
103 AssetsDebtRatio => "assets_debt_ratio",
104 CashRatio => "cash_ratio",
105 EarnedInterestMultiple => "earned_interest_multiple",
106 LongTermDebtEquityRatio => "long_term_debt_equity_ratio",
107 TotalAssetsTurnoverRatio => "total_assets_turnover_ratio",
108 InventoryTurnoverRatio => "inventory_turnover_ratio",
109 CurrentAssetsTurnoverRatio => "current_assets_turnover_ratio",
110 ReceiveAccountTurnoverRatio => "receive_account_turnover_ratio",
111 CashOperatingIndex => "cash_operating_index",
112 OperatingCashFlowNetDivideIncome => "operating_cash_flow_net_divide_income",
113 NetProfitCashContent => "net_profit_cash_content",
114 OperatingCashNetYoyGrowthRatio => "operating_cash_net_yoy_growth_ratio",
115 CashMeetInvestRatio => "cash_meet_invest_ratio",
116 }
117}
118
119#[cfg(test)]
120mod tests {
121 use super::FinancialReport;
122
123 #[test]
124 fn financial_report_uses_standard_fallible_conversion() {
125 let report: FinancialReport = "2024-4".parse().unwrap();
126
127 assert_eq!(report.as_str(), "2024-4");
128 assert!("2024-5".parse::<FinancialReport>().is_err());
129 }
130}