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
145
146
147
148
149
150
151
152
153
154
155

//! Error management.

use std::{ error::Error, fmt, io };

/// A specialized result type for cache operations.
/// 
/// This type is broadly used across rscache for any operation which may produce a 
/// [CacheError](enum.CacheError.html).
/// 
/// # Examples
///
/// A convenience function that bubbles an `rscache::Result` to its caller:
///
/// ```
/// use rscache::OsrsCache;
/// use rscache::codec;
/// 
/// // Same result as Result<Vec<u8>, CacheError>
/// fn item_def_data(cache: &OsrsCache) -> rscache::Result<Vec<u8>> {
///     let index_id = 2;
///     let archive_id = 10;
/// 
///     let buffer = cache.read(index_id, archive_id)?;
///     let buffer = codec::decode(&buffer)?;
/// 
///     Ok(buffer)
/// }
/// ```
pub type Result<T> = std::result::Result<T, CacheError>;

/// Super error type for all sub cache errors
#[derive(Debug)]
pub enum CacheError {
	/// Wrapper for the std::io::Error type.
	Io(io::Error),
	Read(ReadError),
	Compression(CompressionError),
	/// Clarification error for failed parsers.
	Parse(ParseError)
}

macro_rules! impl_from {
	($ty:path, $var:ident) => {
		impl From<$ty> for CacheError {
			#[inline]
			fn from(err: $ty) -> Self {
				Self::$var(err)
			}
		}
	};
}

impl_from!(io::Error, Io);
impl_from!(ReadError, Read);
impl_from!(CompressionError, Compression);
impl_from!(ParseError, Parse);

impl From<nom::Err<()>> for CacheError {
	#[inline]
	fn from(err: nom::Err<()>) -> Self {
		dbg!(err);

		Self::Parse(ParseError::Unknown)
	}
}

impl Error for CacheError {
	#[inline]
	fn source(&self) -> Option<&(dyn Error + 'static)> {
		match self {
			Self::Io(err) => Some(err),
			Self::Read(err) => Some(err),
			Self::Compression(err) => Some(err),
			Self::Parse(err) => Some(err),
		}
	}
}

impl fmt::Display for CacheError {
	#[inline]
	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
		match self {
			Self::Io(err) => err.fmt(f),
			Self::Read(err) => err.fmt(f),
			Self::Compression(err) => err.fmt(f),
			Self::Parse(err) => err.fmt(f),
		}
	}
}

#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
pub enum ReadError {
	IndexNotFound(u8),
	ArchiveNotFound(u8, u32),
	ReferenceTableNotFound,
	NameNotInArchive(i32, String, u8),
	SectorArchiveMismatch(u32, u32),
	SectorChunkMismatch(usize, usize),
	SectorNextMismatch(u32, u32),
	SectorIndexMismatch(u8, u8),
}

impl Error for ReadError {}

impl fmt::Display for ReadError {
	#[inline]
	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
		match self {
			Self::IndexNotFound(id) => write!(f, "Index {} not found.", id),
			Self::ArchiveNotFound(index_id, archive_id) => write!(f, "Index {} does not contain archive group {}.", index_id, archive_id),
			Self::ReferenceTableNotFound => write!(f, "Reference table (index 255) not found."),
			Self::NameNotInArchive(hash, name, index_id) => write!(f, "Identifier hash {} for name {} not found in index {}.", hash, name, index_id),
			Self::SectorArchiveMismatch(received, expected) => write!(f, "Sector archive id was {} but expected {}.", received, expected),
			Self::SectorChunkMismatch(received, expected) => write!(f, "Sector chunk was {} but expected {}.", received, expected),
			Self::SectorNextMismatch(received, expected) => write!(f, "Sector next was {} but expected {}.", received, expected),
			Self::SectorIndexMismatch(received, expected) => write!(f, "Sector parent index id was {} but expected {}.", received, expected),
		}
	}
}

#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
pub enum CompressionError {
	Unsupported(u8),
}

impl Error for CompressionError {}

impl fmt::Display for CompressionError {
	#[inline]
	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
		match self {
			Self::Unsupported(compression) => write!(f, "Invalid compression: {} is unsupported.", compression),
		}
	}
}

#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
pub enum ParseError {
	Unknown,
	Archive(u32),
	Sector(usize),
}

impl Error for ParseError {}

impl fmt::Display for ParseError {
	#[inline]
	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
		match self {
			Self::Unknown => write!(f, "Unknown parser error."),
			Self::Archive(id) => write!(f, "Unable to parse archive {}, unexpected eof.", id),
			Self::Sector(id) => write!(f, "Unable to parse child sector of parent {}, unexpected eof.", id),
		}
	}
}