holofuel_types 0.4.0

Fuel types used for holofuel a mutual credit currency
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

//! Custom error types for HoloFuel transactions
use crate::fraction::Fraction;
use crate::fuel::{Delta, Fuel, Limit};
use std::fmt;

#[derive(thiserror::Error, Debug, Clone)]
pub enum FuelError {
    Range(String),                         // Fuel range exceeded
    FractionOverflow((Fuel, Fraction)),    // Overflow in Fuel * Fraction
    LimitExceeded((Limit, String, Delta)), // An account Limit was exceeded by Fuel value, by the given transaction Delta
    AgentDenied(Limit),                    // All transactions w/ counterparty are denied
    Generic(String), // we want to avoid this one if at all possible and add a new error variant instead
}

// All FuelError display logic is in one place which is here
impl fmt::Display for FuelError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            FuelError::Range(s) => write!(f, "HoloFuel Range Error: {}", s),
            FuelError::FractionOverflow((fuel, fraction)) => {
                write!(f, "HoloFuel overflow in ♓{} * {}", fuel, fraction)
            }
            FuelError::LimitExceeded((limit, total, change)) => write!(
                f,
                "HoloFuel Limit {} exceeded with duration total ♓{}, by tx. ♓{}, on {:?}",
                limit, total, change.1, change.0
            ),
            FuelError::AgentDenied(limit) => write!(
                f,
                "HoloFuel Limit {} denies any counterparty transaction",
                limit
            ),
            FuelError::Generic(s) => write!(f, "HoloFuel Error: {}", s),
        }
    }
}

pub type FuelResult<T> = Result<T, FuelError>;