credit-facility-rs 0.1.0

A rust library for modeling credit facilities with time-aware calculations
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

use thiserror::Error;
use uuid::Uuid;

use crate::decimal::{Money, Rate};
use crate::types::FacilityStatus;

#[derive(Error, Debug)]
pub enum FacilityError {
    #[error("insufficient funds: available {available}, requested {requested}")]
    InsufficientFunds {
        available: Money,
        requested: Money,
    },
    
    #[error("ltv breach: {ltv} exceeds threshold {threshold}")]
    LtvBreach {
        ltv: Rate,
        threshold: Rate,
    },
    
    #[error("invalid payment amount: {amount}")]
    InvalidPaymentAmount {
        amount: Money,
    },
    
    #[error("facility not active: current status is {status:?}")]
    FacilityNotActive {
        status: FacilityStatus,
    },
    
    #[error("overdraft limit exceeded: limit {limit}, requested {requested}")]
    OverdraftLimitExceeded {
        limit: Money,
        requested: Money,
    },
    
    #[error("credit limit exceeded: limit {limit}, requested {requested}")]
    CreditLimitExceeded {
        limit: Money,
        requested: Money,
    },
    
    #[error("milestone not found: {id}")]
    MilestoneNotFound {
        id: Uuid,
    },
    
    #[error("milestone not approved for disbursement: {name}")]
    MilestoneNotApproved {
        name: String,
    },
    
    #[error("invalid configuration: {message}")]
    InvalidConfiguration {
        message: String,
    },
    
    #[error("liquidation in progress")]
    LiquidationInProgress,
    
    #[error("payment schedule not applicable for facility type")]
    PaymentScheduleNotApplicable,
    
    #[error("collateral required for this operation")]
    CollateralRequired,
    
    #[error("no collateral associated with facility")]
    NoCollateral,
    
    #[error("invalid date: {message}")]
    InvalidDate {
        message: String,
    },
    
    #[error("calculation error: {message}")]
    CalculationError {
        message: String,
    },
    
    #[error("facility already settled")]
    FacilityAlreadySettled,
    
    #[error("facility already charged off")]
    FacilityChargedOff,
    
    #[error("invalid interest rate: {rate}")]
    InvalidInterestRate {
        rate: Rate,
    },
    
    #[error("payment less than minimum: minimum {minimum}, provided {provided}")]
    PaymentBelowMinimum {
        minimum: Money,
        provided: Money,
    },
    
    #[error("operation not supported for facility type")]
    OperationNotSupported,
    
    #[error("draw period has ended")]
    DrawPeriodEnded,
    
    #[error("invalid draw amount: {amount}")]
    InvalidDrawAmount {
        amount: Money,
    },
    
    #[error("below minimum drawdown: minimum {minimum}, requested {requested}")]
    BelowMinimumDrawdown {
        minimum: Money,
        requested: Money,
    },
    
    #[error("exceeds credit limit: available {available}, requested {requested}")]
    ExceedsCreditLimit {
        available: Money,
        requested: Money,
    },
    
    #[error("invalid collateral: {message}")]
    InvalidCollateral {
        message: String,
    },
    
    #[error("insufficient collateral: available {available}, required {required}")]
    InsufficientCollateral {
        available: rust_decimal::Decimal,
        required: rust_decimal::Decimal,
    },
    
    #[error("margin call expired: deadline {deadline}, current time {current_time}")]
    MarginCallExpired {
        deadline: chrono::DateTime<chrono::Utc>,
        current_time: chrono::DateTime<chrono::Utc>,
    },
    
    #[error("invalid state: current {current}, expected {expected}")]
    InvalidState {
        current: String,
        expected: String,
    },
}

pub type Result<T> = std::result::Result<T, FacilityError>;