libfmp 1.0.0

Async, typed Rust client for the Financial Modeling Prep API
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
//! Lossless response values for provider fields with mixed wire representations.
//!
//! These types are intentionally narrow. Date-like strings are not passed
//! through one permissive parser because individual endpoint fields document
//! different formats.

use std::{error::Error, fmt, str::FromStr};

use chrono::{DateTime, NaiveDate};
use serde::{Deserialize, Deserializer, Serialize, Serializer, de};
use serde_json::Number;

use crate::types::{ApiDateTime, Date, InvalidTemporalValue};

/// A fiscal year that preserves whether the provider sent a JSON integer or string.
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum FiscalYear {
    Integer(u32),
    String(FiscalYearString),
}

impl FiscalYear {
    pub const fn as_integer(&self) -> Option<u32> {
        match self {
            Self::Integer(value) => Some(*value),
            Self::String(_) => None,
        }
    }

    pub fn as_string(&self) -> Option<&str> {
        match self {
            Self::Integer(_) => None,
            Self::String(value) => Some(value.as_str()),
        }
    }
}

/// A fiscal year received as digit-only JSON text.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct FiscalYearString(String);

impl FiscalYearString {
    pub fn new(value: impl Into<String>) -> Result<Self, InvalidFiscalYear> {
        let value = value.into();
        if value.is_empty() || !value.bytes().all(|byte| byte.is_ascii_digit()) {
            return Err(InvalidFiscalYear);
        }
        Ok(Self(value))
    }

    pub fn as_str(&self) -> &str {
        &self.0
    }
}

impl fmt::Display for FiscalYearString {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(self.as_str())
    }
}

impl FromStr for FiscalYearString {
    type Err = InvalidFiscalYear;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        Self::new(value)
    }
}

/// Why a fiscal-year string was rejected.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct InvalidFiscalYear;

impl fmt::Display for InvalidFiscalYear {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str("fiscal year must contain only ASCII digits")
    }
}

impl Error for InvalidFiscalYear {}

impl Serialize for FiscalYearString {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(self.as_str())
    }
}

impl<'de> Deserialize<'de> for FiscalYearString {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        Self::new(String::deserialize(deserializer)?).map_err(de::Error::custom)
    }
}

impl Serialize for FiscalYear {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match self {
            Self::Integer(value) => serializer.serialize_u32(*value),
            Self::String(value) => value.serialize(serializer),
        }
    }
}

impl<'de> Deserialize<'de> for FiscalYear {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        #[derive(Deserialize)]
        #[serde(untagged)]
        enum WireFiscalYear {
            Integer(u32),
            String(FiscalYearString),
        }

        Ok(match WireFiscalYear::deserialize(deserializer)? {
            WireFiscalYear::Integer(value) => Self::Integer(value),
            WireFiscalYear::String(value) => Self::String(value),
        })
    }
}

/// Why a string-backed numeric representation was rejected.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct InvalidNumericString;

impl fmt::Display for InvalidNumericString {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str("value must be a JSON numeric string")
    }
}

impl Error for InvalidNumericString {}

/// A validated JSON number kept in its original string representation.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct NumericString(String);

impl NumericString {
    pub fn new(value: impl Into<String>) -> Result<Self, InvalidNumericString> {
        let value = value.into();
        if value.trim() != value || serde_json::from_str::<Number>(&value).is_err() {
            return Err(InvalidNumericString);
        }
        Ok(Self(value))
    }

    pub fn as_str(&self) -> &str {
        &self.0
    }

    pub fn into_inner(self) -> String {
        self.0
    }
}

impl fmt::Display for NumericString {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(self.as_str())
    }
}

impl FromStr for NumericString {
    type Err = InvalidNumericString;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        Self::new(value)
    }
}

impl Serialize for NumericString {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(self.as_str())
    }
}

impl<'de> Deserialize<'de> for NumericString {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        Self::new(String::deserialize(deserializer)?).map_err(de::Error::custom)
    }
}

/// A JSON number or numeric string, preserving the provider's wire kind.
#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub enum NumberOrNumericString {
    Number(Number),
    String(NumericString),
}

impl NumberOrNumericString {
    pub const fn as_number(&self) -> Option<&Number> {
        match self {
            Self::Number(value) => Some(value),
            Self::String(_) => None,
        }
    }

    pub fn as_numeric_string(&self) -> Option<&str> {
        match self {
            Self::Number(_) => None,
            Self::String(value) => Some(value.as_str()),
        }
    }
}

impl Serialize for NumberOrNumericString {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match self {
            Self::Number(value) => value.serialize(serializer),
            Self::String(value) => value.serialize(serializer),
        }
    }
}

impl<'de> Deserialize<'de> for NumberOrNumericString {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        #[derive(Deserialize)]
        #[serde(untagged)]
        enum WireNumber {
            Number(Number),
            String(NumericString),
        }

        Ok(match WireNumber::deserialize(deserializer)? {
            WireNumber::Number(value) => Self::Number(value),
            WireNumber::String(value) => Self::String(value),
        })
    }
}

/// A percentage string containing a numeric representation followed by `%`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct PercentString(String);

impl PercentString {
    pub fn new(value: impl Into<String>) -> Result<Self, InvalidNumericString> {
        let value = value.into();
        let Some(number) = value.strip_suffix('%') else {
            return Err(InvalidNumericString);
        };
        NumericString::new(number)?;
        Ok(Self(value))
    }

    pub fn as_str(&self) -> &str {
        &self.0
    }
}

impl fmt::Display for PercentString {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(self.as_str())
    }
}

impl FromStr for PercentString {
    type Err = InvalidNumericString;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        Self::new(value)
    }
}

impl Serialize for PercentString {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(self.as_str())
    }
}

impl<'de> Deserialize<'de> for PercentString {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        Self::new(String::deserialize(deserializer)?).map_err(de::Error::custom)
    }
}

/// A percentage preserving number, numeric-string, and percent-string forms.
///
/// No variant is scaled: `0.25`, `"0.25"`, and `"25%"` remain exactly those
/// three representations.
#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub enum PercentageValue {
    Number(Number),
    NumericString(NumericString),
    PercentString(PercentString),
}

impl PercentageValue {
    pub const fn as_number(&self) -> Option<&Number> {
        match self {
            Self::Number(value) => Some(value),
            Self::NumericString(_) | Self::PercentString(_) => None,
        }
    }

    pub fn as_numeric_string(&self) -> Option<&str> {
        match self {
            Self::NumericString(value) => Some(value.as_str()),
            Self::Number(_) | Self::PercentString(_) => None,
        }
    }

    pub fn as_percent_string(&self) -> Option<&str> {
        match self {
            Self::PercentString(value) => Some(value.as_str()),
            Self::Number(_) | Self::NumericString(_) => None,
        }
    }
}

impl Serialize for PercentageValue {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match self {
            Self::Number(value) => value.serialize(serializer),
            Self::NumericString(value) => value.serialize(serializer),
            Self::PercentString(value) => value.serialize(serializer),
        }
    }
}

impl<'de> Deserialize<'de> for PercentageValue {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        #[derive(Deserialize)]
        #[serde(untagged)]
        enum WirePercentage {
            Number(Number),
            String(String),
        }

        match WirePercentage::deserialize(deserializer)? {
            WirePercentage::Number(value) => Ok(Self::Number(value)),
            WirePercentage::String(value) if value.ends_with('%') => PercentString::new(value)
                .map(Self::PercentString)
                .map_err(de::Error::custom),
            WirePercentage::String(value) => NumericString::new(value)
                .map(Self::NumericString)
                .map_err(de::Error::custom),
        }
    }
}

macro_rules! string_bool {
    ($name:ident, $true_wire:literal, $false_wire:literal, $description:literal) => {
        #[doc = $description]
        #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
        pub enum $name {
            True,
            False,
        }

        impl $name {
            pub const fn as_bool(self) -> bool {
                matches!(self, Self::True)
            }

            pub const fn as_str(self) -> &'static str {
                match self {
                    Self::True => $true_wire,
                    Self::False => $false_wire,
                }
            }
        }

        impl fmt::Display for $name {
            fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
                formatter.write_str(self.as_str())
            }
        }

        impl Serialize for $name {
            fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
            where
                S: Serializer,
            {
                serializer.serialize_str(self.as_str())
            }
        }

        impl<'de> Deserialize<'de> for $name {
            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
            where
                D: Deserializer<'de>,
            {
                match String::deserialize(deserializer)?.as_str() {
                    $true_wire => Ok(Self::True),
                    $false_wire => Ok(Self::False),
                    other => Err(de::Error::unknown_variant(
                        other,
                        &[$true_wire, $false_wire],
                    )),
                }
            }
        }
    };
}

/// A documented native JSON boolean. The wrapper keeps it distinct from string flags.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(transparent)]
pub struct WireBool(pub bool);

string_bool!(YnFlag, "Y", "N", "A provider `Y`/`N` string flag.");
string_bool!(YesNoFlag, "Yes", "No", "A provider `Yes`/`No` string flag.");
string_bool!(
    TrueFalseFlag,
    "true",
    "false",
    "A provider lowercase `true`/`false` string flag."
);
string_bool!(
    TitleCaseBoolFlag,
    "True",
    "False",
    "A provider title-case `True`/`False` string flag."
);

/// Dynamic endpoint JSON, recursively represented without assuming object keys.
pub type DynamicJson = serde_json::Value;

/// Object-root dynamic endpoint JSON with arbitrary member names and value shapes.
///
/// This preserves JSON values, including arbitrary-precision integer tokens,
/// without treating object-member order as semantic. Duplicate member names
/// therefore follow the JSON map model and are not preserved independently.
/// No order-preservation dependency is enabled for this contract.
pub type DynamicObject = serde_json::Map<String, DynamicJson>;

/// A strict RFC 3339 timestamp that preserves its original offset and precision.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct IsoTimestamp(String);

impl IsoTimestamp {
    pub fn parse(value: &str) -> Result<Self, InvalidTemporalValue> {
        DateTime::parse_from_rfc3339(value)
            .map(|_| Self(value.to_owned()))
            .map_err(|_| InvalidTemporalValue::new("RFC 3339 timestamp"))
    }

    pub fn as_str(&self) -> &str {
        &self.0
    }
}

impl fmt::Display for IsoTimestamp {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(self.as_str())
    }
}

impl FromStr for IsoTimestamp {
    type Err = InvalidTemporalValue;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        Self::parse(value)
    }
}

impl Serialize for IsoTimestamp {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(self.as_str())
    }
}

impl<'de> Deserialize<'de> for IsoTimestamp {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        Self::parse(&String::deserialize(deserializer)?).map_err(de::Error::custom)
    }
}

/// A field documented as either `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum DateOrDateTime {
    Date(Date),
    DateTime(ApiDateTime),
}

impl DateOrDateTime {
    pub const fn as_date(self) -> Option<Date> {
        match self {
            Self::Date(value) => Some(value),
            Self::DateTime(_) => None,
        }
    }

    pub const fn as_datetime(self) -> Option<ApiDateTime> {
        match self {
            Self::Date(_) => None,
            Self::DateTime(value) => Some(value),
        }
    }
}

impl fmt::Display for DateOrDateTime {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Date(value) => value.fmt(formatter),
            Self::DateTime(value) => value.fmt(formatter),
        }
    }
}

impl FromStr for DateOrDateTime {
    type Err = InvalidTemporalValue;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        if value.len() == 10 {
            Date::parse(value).map(Self::Date)
        } else if value.len() == 19 {
            ApiDateTime::parse(value).map(Self::DateTime)
        } else {
            Err(InvalidTemporalValue::new(
                "YYYY-MM-DD date or YYYY-MM-DD HH:MM:SS datetime",
            ))
        }
    }
}

impl Serialize for DateOrDateTime {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.collect_str(self)
    }
}

impl<'de> Deserialize<'de> for DateOrDateTime {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        String::deserialize(deserializer)?
            .parse()
            .map_err(de::Error::custom)
    }
}

/// A US-formatted date represented exactly as `MM-DD-YYYY`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct UsDate(NaiveDate);

impl UsDate {
    pub fn parse(value: &str) -> Result<Self, InvalidTemporalValue> {
        const EXPECTED: &str = "MM-DD-YYYY date";
        let exact_shape = value.len() == 10
            && value.is_ascii()
            && value.bytes().enumerate().all(|(index, byte)| match index {
                2 | 5 => byte == b'-',
                _ => byte.is_ascii_digit(),
            });
        if !exact_shape {
            return Err(InvalidTemporalValue::new(EXPECTED));
        }
        NaiveDate::parse_from_str(value, "%m-%d-%Y")
            .map(Self)
            .map_err(|_| InvalidTemporalValue::new(EXPECTED))
    }

    /// Returns the inner calendar date.
    pub const fn into_inner(self) -> NaiveDate {
        self.0
    }
}

impl fmt::Display for UsDate {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(formatter, "{}", self.0.format("%m-%d-%Y"))
    }
}

impl FromStr for UsDate {
    type Err = InvalidTemporalValue;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        Self::parse(value)
    }
}

impl Serialize for UsDate {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.collect_str(self)
    }
}

impl<'de> Deserialize<'de> for UsDate {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        Self::parse(&String::deserialize(deserializer)?).map_err(de::Error::custom)
    }
}

/// Opaque human-readable or partial date text, preserved without date parsing.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(transparent)]
pub struct OpaqueDateText(pub String);

macro_rules! optional_temporal_module {
    ($module:ident, $type:ty) => {
        #[doc(hidden)]
        pub mod $module {
            use super::*;

            pub fn deserialize<'de, D>(deserializer: D) -> Result<Option<$type>, D::Error>
            where
                D: Deserializer<'de>,
            {
                let value = Option::<String>::deserialize(deserializer)?;
                value
                    .filter(|value| !value.is_empty())
                    .map(|value| value.parse().map_err(de::Error::custom))
                    .transpose()
            }

            pub fn serialize<S>(value: &Option<$type>, serializer: S) -> Result<S::Ok, S::Error>
            where
                S: Serializer,
            {
                match value {
                    Some(value) => serializer.collect_str(value),
                    None => serializer.serialize_none(),
                }
            }
        }
    };
}

optional_temporal_module!(empty_or_null_date, Date);
optional_temporal_module!(empty_or_null_date_or_datetime, DateOrDateTime);

/// Codec for a required wire key whose absent date is represented by `""`.
///
/// Serde wiring for the response models, hidden from the documented API and
/// exempt from semver guarantees, like the other `with` helper modules here.
///
/// Unlike [`empty_or_null_date`], JSON null is rejected and `None` serializes
/// back to the provider's exact empty-string sentinel. Do not add
/// `#[serde(default)]` at call sites when the response key is required.
#[doc(hidden)]
pub mod empty_date {
    use super::*;

    pub fn deserialize<'de, D>(deserializer: D) -> Result<Option<Date>, D::Error>
    where
        D: Deserializer<'de>,
    {
        let value = String::deserialize(deserializer)?;
        if value.is_empty() {
            Ok(None)
        } else {
            value.parse().map(Some).map_err(de::Error::custom)
        }
    }

    pub fn serialize<S>(value: &Option<Date>, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match value {
            Some(value) => serializer.collect_str(value),
            None => serializer.serialize_str(""),
        }
    }
}

/// Serializers for response fields typed with an integral-`f64` alias.
///
/// The provider documents fields such as [`Volume`](crate::types::Volume)
/// and [`MarketCapitalization`](crate::types::MarketCapitalization) as JSON
/// integers but intermittently sends a fractional or exponent-form number,
/// so they are `f64` fields that deserialize from any JSON number.
/// Re-encoding writes a finite integral value back as a JSON integer (so a
/// documented row round-trips byte-for-byte), any other finite value as a
/// JSON float, and NaN or an infinity as `null`. Apply [`serialize`] with
/// `serialize_with` on a bare alias field and [`serialize_option`] on an
/// `Option` of one; deserialization is serde's default `f64` path.
pub(crate) mod integral_f64 {
    use super::*;

    pub(crate) fn serialize<S>(value: &f64, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        if value.is_finite() && value.fract() == 0.0 {
            if *value >= 0.0 && *value < u64::MAX as f64 {
                return serializer.serialize_u64(*value as u64);
            }
            if *value < 0.0 && *value >= i64::MIN as f64 {
                return serializer.serialize_i64(*value as i64);
            }
        }
        serializer.serialize_f64(*value)
    }

    pub(crate) fn serialize_option<S>(value: &Option<f64>, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match value {
            Some(value) => serialize(value, serializer),
            None => serializer.serialize_none(),
        }
    }
}

#[cfg(test)]
mod tests {
    use serde::{Deserialize, Serialize};

    use crate::types::Volume;

    #[test]
    fn integral_f64_accepts_any_json_number_and_re_encodes_integral_values_as_integers() {
        #[derive(Debug, PartialEq, Serialize, Deserialize)]
        struct Row {
            #[serde(serialize_with = "super::integral_f64::serialize")]
            volume: Volume,
        }
        let encoded = |value: f64| serde_json::to_string(&Row { volume: value }).unwrap();

        let documented: Row = serde_json::from_str(r#"{"volume":28718014}"#).unwrap();
        let observed: Row = serde_json::from_str(r#"{"volume":20201922.82733}"#).unwrap();
        assert_eq!(documented.volume, 28_718_014.0);
        assert_eq!(observed.volume, 20_201_922.827_33);
        assert_eq!(
            serde_json::to_string(&documented).unwrap(),
            r#"{"volume":28718014}"#
        );
        assert_eq!(
            serde_json::to_string(&observed).unwrap(),
            r#"{"volume":20201922.82733}"#
        );

        assert_eq!(encoded(0.0), r#"{"volume":0}"#);
        assert_eq!(encoded(-0.0), r#"{"volume":0}"#);
        assert_eq!(encoded(4_294_967_296.0), r#"{"volume":4294967296}"#);
        assert_eq!(encoded(-1.0), r#"{"volume":-1}"#);
        assert_eq!(encoded(1.5), r#"{"volume":1.5}"#);
        assert_eq!(
            encoded(9_007_199_254_740_992.0),
            r#"{"volume":9007199254740992}"#,
            "2^53 is integral and still emits an integer"
        );
        assert_eq!(
            encoded(18_446_744_073_709_549_568.0),
            r#"{"volume":18446744073709549568}"#,
            "the largest f64 below 2^64 casts to u64 exactly"
        );
        assert_eq!(
            encoded(i64::MIN as f64),
            r#"{"volume":-9223372036854775808}"#,
            "-2^63 is the last negative integral value that fits an i64"
        );
        assert_eq!(encoded(f64::NAN), r#"{"volume":null}"#);
        assert_eq!(encoded(f64::INFINITY), r#"{"volume":null}"#);
        assert_eq!(encoded(f64::NEG_INFINITY), r#"{"volume":null}"#);
        assert_eq!(
            serde_json::to_value(Row {
                volume: 32_030_003_200.0
            })
            .unwrap()["volume"]
                .as_u64(),
            Some(32_030_003_200)
        );
        let beyond_u64 = serde_json::to_value(Row {
            volume: u64::MAX as f64,
        })
        .unwrap();
        assert!(beyond_u64["volume"].is_f64());
        assert_eq!(beyond_u64["volume"].as_f64(), Some(u64::MAX as f64));
        assert!(serde_json::from_str::<Row>(r#"{"volume":"1"}"#).is_err());
        assert!(serde_json::from_str::<Row>(r#"{"volume":null}"#).is_err());
    }

    #[test]
    fn integral_f64_option_writes_null_for_none_and_integers_for_integral_values() {
        #[derive(Debug, PartialEq, Serialize, Deserialize)]
        struct Row {
            #[serde(serialize_with = "super::integral_f64::serialize_option")]
            market_cap: Option<f64>,
        }
        let encoded =
            |value: Option<f64>| serde_json::to_string(&Row { market_cap: value }).unwrap();

        assert_eq!(encoded(None), r#"{"market_cap":null}"#);
        assert_eq!(encoded(Some(1e9)), r#"{"market_cap":1000000000}"#);
        assert_eq!(encoded(Some(1.5)), r#"{"market_cap":1.5}"#);
        assert_eq!(encoded(Some(f64::NAN)), r#"{"market_cap":null}"#);
        let exponent: Row = serde_json::from_str(r#"{"market_cap":3.1e12}"#).unwrap();
        assert_eq!(exponent.market_cap, Some(3.1e12));
        let null: Row = serde_json::from_str(r#"{"market_cap":null}"#).unwrap();
        assert_eq!(null.market_cap, None);
    }
}