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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196


use std::fmt;

macro_rules! read_fn {
	($name:ident, $try_name:ident, $type:ident, $num:expr) => (
		read_fn!(
			$name, $try_name,
			$type, $num, stringify!($type), stringify!($num)
		);
	);
	($name:ident, $try_name:ident, $type:ident, $num:expr,
	$type_str:expr, $num_str:expr) => {
		#[inline]
		#[doc = "Try to read "]
		#[doc = $num_str]
		#[doc = " bytes in big-endian converting them into an `"]
		#[doc = $type_str]
		#[doc = "`."]
		fn $try_name(&mut self) -> Result<$type, ReadError> {
			self.try_read($num)?
				.try_into()
				.map($type::from_be_bytes)
				.map_err(|_| ReadError)
		}

		#[inline]
		#[track_caller]
		#[doc = "Reads "]
		#[doc = $num_str]
		#[doc = " bytes in big-endian converting them into an `"]
		#[doc = $type_str]
		#[doc = "`."]
		///
		/// ## Panics
		/// If there aren't enough bytes left.
		fn $name(&mut self) -> $type {
			self.$try_name().expect(concat!("failed to read ", $type_str))
		}
	}
}

macro_rules! read_le_fn {
	($name:ident, $try_name:ident, $type:ident, $num:expr) => (
		read_le_fn!(
			$name, $try_name,
			$type, $num, stringify!($type), stringify!($num)
		);
	);
	($name:ident, $try_name:ident, $type:ident, $num:expr,
	$type_str:expr, $num_str:expr) => {
		#[inline]
		#[doc = "Try to read "]
		#[doc = $num_str]
		#[doc = " bytes in little-endian converting them into an `"]
		#[doc = $type_str]
		#[doc = "`."]
		fn $try_name(&mut self) -> Result<$type, ReadError> {
			self.try_read($num)?
				.try_into()
				.map($type::from_le_bytes)
				.map_err(|_| ReadError)
		}

		#[inline]
		#[track_caller]
		#[doc = "Reads "]
		#[doc = $num_str]
		#[doc = " bytes in little-endian converting them into an `"]
		#[doc = $type_str]
		#[doc = "`."]
		///
		/// ## Panics
		/// If there aren't enough bytes left.
		fn $name(&mut self) -> $type {
			self.$try_name().expect(concat!("failed to read ", $type_str))
		}
	}
}

/// Get's returned when there is not enough space to read everything.
/// If this get's returned nothing was read.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ReadError;

impl fmt::Display for ReadError {
	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
		fmt::Debug::fmt(self, f)
	}
}

impl std::error::Error for ReadError {}

/// Read bytes or numbers.
pub trait BytesRead {

	/// Returns the entire slice.
	fn as_slice(&self) -> &[u8];

	/// Returns the length of the entire slice.
	#[inline]
	fn len(&self) -> usize {
		self.as_slice().len()
	}

	/// Returns all remaining bytes.
	fn remaining(&self) -> &[u8];

	/// Try to read a given length of bytes.
	/// 
	/// ## Failes
	/// If len exceeds `self.remaining().len()`.
	fn try_read(&mut self, len: usize) -> Result<&[u8], ReadError>;

	/// Reads a given length of bytes.
	/// 
	/// ## Panics
	/// If len exceeds `self.remaining().len()`.
	#[track_caller]
	fn read(&mut self, len: usize) -> &[u8] {
		self.try_read(len).expect("failed to read")
	}

	read_fn!(read_u8, try_read_u8, u8, 1);
	read_fn!(read_u16, try_read_u16, u16, 2);
	read_fn!(read_u32, try_read_u32, u32, 4);
	read_fn!(read_u64, try_read_u64, u64, 8);
	read_fn!(read_u128, try_read_u128, u128, 16);

	read_fn!(read_i8, try_read_i8, i8, 1);
	read_fn!(read_i16, try_read_i16, i16, 2);
	read_fn!(read_i32, try_read_i32, i32, 4);
	read_fn!(read_i64, try_read_i64, i64, 8);
	read_fn!(read_i128, try_read_i128, i128, 16);

	read_fn!(read_f32, try_read_f32, f32, 4);
	read_fn!(read_f64, try_read_f64, f64, 8);

	read_le_fn!(read_le_u8, try_read_le_u8, u8, 1);
	read_le_fn!(read_le_u16, try_read_le_u16, u16, 2);
	read_le_fn!(read_le_u32, try_read_le_u32, u32, 4);
	read_le_fn!(read_le_u64, try_read_le_u64, u64, 8);
	read_le_fn!(read_le_u128, try_read_le_u128, u128, 16);

	read_le_fn!(read_le_i8, try_read_le_i8, i8, 1);
	read_le_fn!(read_le_i16, try_read_le_i16, i16, 2);
	read_le_fn!(read_le_i32, try_read_le_i32, i32, 4);
	read_le_fn!(read_le_i64, try_read_le_i64, i64, 8);
	read_le_fn!(read_le_i128, try_read_le_i128, i128, 16);

	read_le_fn!(read_le_f32, try_read_le_f32, f32, 4);
	read_le_fn!(read_le_f64, try_read_le_f64, f64, 8);

	/// Tries to read a given length without updating
	/// the internal position. Returns `None` if there are not enought
	/// bytes remaining.
	fn peek(&self, len: usize) -> Option<&[u8]>;

}

/// Read bytes while keeping the original reference.
/// ```
/// use simple_bytes::{Bytes, BytesRead, BytesReadRef};
///
/// let mut bytes = Bytes::from("hey".as_ref());
/// let h = bytes.read_u8();
/// let ey: &'static [u8] = bytes.remaining_ref();
/// ```
pub trait BytesReadRef<'a>: BytesRead {

	/// Returns the entire slice.
	fn as_slice_ref(&self) -> &'a [u8];

	/// Returns all remaining bytes.
	fn remaining_ref(&self) -> &'a [u8];

	/// Try to read a given length of bytes.
	/// 
	/// ## Failes
	/// If len exceeds `self.remaining().len()`.
	fn try_read_ref(&mut self, len: usize) -> Result<&'a [u8], ReadError>;

	/// Reads a given length of bytes.
	/// 
	/// ## Panics
	/// If len exceeds `self.remaining().len()`.
	#[track_caller]
	fn read_ref(&mut self, len: usize) -> &'a [u8] {
		self.try_read_ref(len).expect("failed to read")
	}

	/// Tries to read a given length without updating
	/// the internal position. Returns `None` if there are not enought
	/// bytes remaining.
	fn peek_ref(&self, len: usize) -> Option<&'a [u8]>;

}