lexe-common 0.1.6

Lexe common types, traits, and utilities
Documentation
use std::{
    fmt::{self, Display},
    str::FromStr,
};

#[cfg(any(test, feature = "test-utils"))]
use proptest_derive::Arbitrary;
use serde::{Deserialize, Serialize};

use crate::ln::amount::Amount;

/// An enum used to send either (1) an explicit amount, or (2) the full
/// spendable balance.
///
/// This container type provides a nice JSON-serialization and is less
/// error-prone and more explicit than `Option<Amount>`.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
#[derive(Serialize, Deserialize)]
#[cfg_attr(any(test, feature = "test-utils"), derive(Arbitrary))]
pub enum AmountOrAll {
    #[serde(rename = "all")]
    All,

    #[serde(untagged)]
    Amount(Amount),
}

impl Display for AmountOrAll {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::All => f.write_str("all"),
            Self::Amount(amount) => Display::fmt(amount, f),
        }
    }
}

impl FromStr for AmountOrAll {
    type Err = anyhow::Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        if s == "all" {
            Ok(Self::All)
        } else {
            Amount::from_str(s).map(Self::Amount)
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::test_utils::roundtrip;

    #[test]
    fn test_fromstr_json_string_equiv() {
        roundtrip::fromstr_json_string_equiv::<AmountOrAll>();
    }

    #[test]
    fn test_json() {
        #[derive(Debug, Serialize, Deserialize)]
        struct Dummy {
            amount: AmountOrAll,
        }

        let amount = Dummy {
            amount: AmountOrAll::Amount(Amount::from_sats_u32(123000)),
        };
        let all = Dummy {
            amount: AmountOrAll::All,
        };

        println!("{}", serde_json::to_string_pretty(&amount).unwrap());
        println!("{}", serde_json::to_string_pretty(&all).unwrap());

        let json1 = r#"{ "amount": "123000" }"#;
        let json2 = r#"{ "amount": "all" }"#;

        assert_eq!(
            amount.amount,
            serde_json::from_str::<Dummy>(json1).unwrap().amount,
        );
        assert_eq!(
            all.amount,
            serde_json::from_str::<Dummy>(json2).unwrap().amount
        );
    }
}