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

use std::error::Error;
use std::fmt;

use thiserror::Error;

/// The error type for [`Unreal4Error`].
#[non_exhaustive]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Unreal4ErrorKind {
    /// Empty data blob received.
    Empty,

    /// Invalid compressed data.
    BadCompression,

    /// Invalid contents of the crash file container.
    BadData,

    /// The crash file contains unexpected trailing data after the footer.
    TrailingData,

    /// Can't process a log entry.
    InvalidLogEntry,

    /// Invalid XML.
    InvalidXml,
}

impl fmt::Display for Unreal4ErrorKind {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Empty => write!(f, "empty crash"),
            Self::BadCompression => write!(f, "bad compression"),
            Self::BadData => write!(f, "invalid crash file contents"),
            Self::TrailingData => write!(f, "unexpected trailing data"),
            Self::InvalidLogEntry => write!(f, "invalid log entry"),
            Self::InvalidXml => write!(f, "invalid xml"),
        }
    }
}

/// An error returned when handling an UE4 crash file.
#[derive(Debug, Error)]
#[error("{kind}")]
pub struct Unreal4Error {
    kind: Unreal4ErrorKind,
    #[source]
    source: Option<Box<dyn Error + Send + Sync + 'static>>,
}

impl Unreal4Error {
    /// Creates a new Unreal4 error from a known kind of error as well as an
    /// arbitrary error payload.
    pub(crate) fn new<E>(kind: Unreal4ErrorKind, source: E) -> Self
    where
        E: Into<Box<dyn Error + Send + Sync>>,
    {
        let source = Some(source.into());
        Self { kind, source }
    }

    /// Returns the corresponding [`Unreal4ErrorKind`] for this error.
    pub fn kind(&self) -> Unreal4ErrorKind {
        self.kind
    }
}

impl From<Unreal4ErrorKind> for Unreal4Error {
    fn from(kind: Unreal4ErrorKind) -> Self {
        Self { kind, source: None }
    }
}

impl From<elementtree::Error> for Unreal4Error {
    fn from(source: elementtree::Error) -> Self {
        Self::new(Unreal4ErrorKind::InvalidXml, source)
    }
}

impl From<scroll::Error> for Unreal4Error {
    fn from(source: scroll::Error) -> Self {
        Self::new(Unreal4ErrorKind::BadData, source)
    }
}