destination 0.1.2

A library providing types and method for managing physical addresses in a municipality.
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

/// The `AddressError` struct serves as the main error type for the `address` library.
#[derive(Debug, derive_more::From, derive_more::Display, derive_more::Error)]
#[from(AddressErrorKind)]
pub struct AddressError {
    kind: Box<AddressErrorKind>,
}

macro_rules! impl_address_error {
    ( $( $name:ident),* ) => {
        $(
            impl From<$name> for AddressError {
                fn from(value: $name) -> Self {
                    let kind = Box::new(AddressErrorKind::from(value));
                    Self { kind }
                }
            }
        )*
    };
    ( $( $name:ident),+ ,) => {
       impl_address_err![ $( $name ),* ];
    };
}

impl_address_error!(Decode, Encode, Io, Nom);

/// The `AddressErrorKind` enum contains the individual error type associated with the library operation.
#[derive(Debug, derive_more::From, derive_more::Display, derive_more::Error)]
pub enum AddressErrorKind {
    /// The `Decode` variant contains a [`Decode`] error.
    #[from(Decode)]
    Decode(Decode),
    /// The `Encode` variant contains a [`Encode`] error.
    #[from(Encode)]
    Encode(Encode),
    /// The `Builder` variant contains a [`Builder`] error.
    #[from(Builder)]
    Builder,
    /// The `Csv` variant contains a [`Csv`] error.
    #[from(Csv)]
    Csv(Csv),
    /// The `Io` variant contains an [`Io`] error.
    #[from(Io)]
    Io(Io),
    /// The `Nom` variant contains an [`Nom`] error.
    #[from(Nom)]
    Nom(Nom),
}

/// The `Io` struct contains error information associated with input/output calls.
#[derive(Debug, derive_more::Display, derive_more::Error, derive_new::new)]
#[display("io error at path {path:?} in line {line} of {file}")]
pub struct Io {
    path: std::path::PathBuf,
    source: std::io::Error,
    line: u32,
    file: String,
}

/// The `Csv` struct contains error information associated with the `csv` crate.
#[derive(Debug, derive_more::Display, derive_more::Error, derive_new::new)]
#[display("csv error at path {path:?} in line {line} of {file}")]
pub struct Csv {
    path: std::path::PathBuf,
    source: csv::Error,
    line: u32,
    file: String,
}

/// The `Decode` struct contains decode error information associated with the `bincode` crate.
#[derive(Debug, derive_more::Display, derive_more::Error, derive_new::new)]
#[display("bincode decode error: {source:?} at line {line} in {file}")]
pub struct Decode {
    source: bincode::error::DecodeError,
    line: u32,
    file: String,
}

/// The `Encode` struct contains encoding error information associated with the `bincode` crate.
#[derive(Debug, derive_more::Display, derive_more::Error, derive_new::new)]
#[display("bincode encode error: {source:?} at line {line} in {file}")]
pub struct Encode {
    source: bincode::error::EncodeError,
    line: u32,
    file: String,
}

/// The `Builder` struct contains error information about failure to construct a type from a builder.
#[derive(Debug, derive_more::Display, derive_new::new)]
#[display("Error constructing {target}: {issue} in line {line} of {file}")]
pub struct Builder {
    issue: String,
    target: String,
    line: u32,
    file: String,
}

impl std::error::Error for Builder {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        None
    }
}

/// The `Nom` struct contains error information associated with the `nom` crate.
#[derive(Debug, derive_more::Display, derive_more::Error)]
#[display("nom parsing error: {description} in line {line} of {file}")]
pub struct Nom {
    description: String,
    source: nom::Err<nom::error::Error<String>>,
    line: u32,
    file: String,
}

impl Nom {
    /// The `new` method creates a new instance of the error type.
    pub fn new(
        description: String,
        source: nom::Err<nom::error::Error<&str>>,
        line: u32,
        file: String,
    ) -> Self {
        let source = source.to_owned();
        Self {
            description,
            source,
            line,
            file,
        }
    }
}