bitcoincash_addr/cashaddr/
errors.rs

1use std::{error::Error, fmt};
2
3/// Error concerning encoding of cashaddrs.
4#[derive(Debug, PartialEq, Eq, Clone)]
5pub struct EncodingError(pub usize);
6
7impl fmt::Display for EncodingError {
8    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
9        write!(f, "invalid length ({})", self.0)
10    }
11}
12
13impl Error for EncodingError {
14    fn cause(&self) -> Option<&dyn Error> {
15        None
16    }
17    fn description(&self) -> &str {
18        "invalid length"
19    }
20}
21
22/// Error concerning decoding of cashaddrs.
23#[derive(Debug, PartialEq, Eq, Clone)]
24pub enum DecodingError {
25    /// Invalid length (length).
26    InvalidLength(usize),
27    /// Zero or multiple prefixes.
28    NoPrefix,
29    /// Failed to match known prefixes (prefix).
30    InvalidPrefix(String),
31    /// Checksum failed (checksum).
32    ChecksumFailed(u64),
33    /// Unexpected character (char).
34    InvalidChar(char),
35    /// Version byte was not recognized.
36    InvalidVersion(u8),
37    /// Upper and lowercase address string.
38    MixedCase,
39}
40
41impl fmt::Display for DecodingError {
42    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
43        match self {
44            DecodingError::ChecksumFailed(actual) => {
45                write!(f, "invalid checksum (actual {} != 0)", actual)
46            }
47            DecodingError::InvalidChar(index) => write!(f, "invalid char ({})", index),
48            DecodingError::NoPrefix => write!(f, "zero or multiple prefixes"),
49            DecodingError::MixedCase => write!(f, "mixed case string"),
50            DecodingError::InvalidVersion(c) => write!(f, "invalid version byte ({})", c),
51            DecodingError::InvalidPrefix(prefix) => write!(f, "invalid prefix ({})", prefix),
52            DecodingError::InvalidLength(length) => write!(f, "invalid length ({})", length),
53        }
54    }
55}
56
57impl Error for DecodingError {
58    fn cause(&self) -> Option<&dyn Error> {
59        None
60    }
61    fn description(&self) -> &str {
62        match *self {
63            DecodingError::ChecksumFailed { .. } => "invalid checksum",
64            DecodingError::InvalidChar(_) => "invalid char",
65            DecodingError::NoPrefix => "zero or multiple prefixes",
66            DecodingError::MixedCase => "mixed case string",
67            DecodingError::InvalidVersion(_) => "invalid version byte",
68            DecodingError::InvalidPrefix(_) => "invalid prefix",
69            DecodingError::InvalidLength(_) => "invalid length",
70        }
71    }
72}
bitcoincash_addr/cashaddr/errors.rs

bitcoincash_addr/cashaddr/
errors.rs
