paystack-rs 1.6.0

Paystack API Wrapper
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

//! Currency
//! ===============
//! This file contains the currency options for the paystack API.

use serde::{Deserialize, Serialize};
use std::fmt;

/// Represents different currencies supported by the Paystack API.
///
/// The `Currency` enum defines the possible currency options that can be used with Paystack,
/// including Nigerian Naira (NGN), Ghanaian Cedis (GHS), American Dollar (USD),
/// and South African Rands (ZAR). It also includes an `EMPTY` variant to represent cases
/// where the currency can be empty.
///
/// # Variants
///
/// - `NGN`: Nigerian Naira.
/// - `GHS`: Ghanaian Cedis.
/// - `USD`: American Dollar.
/// - `ZAR`: South African Rands.
/// - `KES`: Kenya Shilling.
/// - `XOF`: West African CFA Franc.
/// - `EMPTY`: Used when the currency can be empty.
///
/// # Examples
///
/// ```
/// use paystack::Currency;
///
/// let ngn = Currency::NGN;
/// let ghs = Currency::GHS;
/// let usd = Currency::USD;
/// let zar = Currency::ZAR;
/// let kes = Currency::KES;
/// let xof = Currency::XOF;
/// let empty = Currency::EMPTY;
///
/// println!("{:?}", ngn); // Prints: NGN
/// ```
///
/// The example demonstrates the usage of the `Currency` enum from the Paystack crate,
/// creating instances of each variant and printing a debug representation.
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq)]
pub enum Currency {
    /// Nigerian Naira
    #[default]
    NGN,
    /// Ghanaian Cedis
    GHS,
    /// American Dollar
    USD,
    /// South African Rands
    ZAR,
    /// Kenya Shilling
    KES,
    /// West African CFA Franc
    XOF,
    /// Used when currency can be empty.
    EMPTY,
}

impl fmt::Display for Currency {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let currency = match self {
            Currency::NGN => "NGN",
            Currency::GHS => "GHS",
            Currency::USD => "USD",
            Currency::ZAR => "ZAR",
            Currency::KES => "KES",
            Currency::XOF => "XOF",
            Currency::EMPTY => "",
        };
        write!(f, "{currency}")
    }
}