casper-wasm 1.0.0

//! Simple abstractions for the IO operations.
//!
//! Basically it just a replacement for the std::io that is usable from
//! the `no_std` environment.

#[cfg(feature = "std")]
use std::io;

/// IO specific error.
#[derive(Debug)]
pub enum Error {
	/// Some unexpected data left in the buffer after reading all data.
	TrailingData,

	/// Unexpected End-Of-File
	UnexpectedEof,

	/// Invalid data is encountered.
	InvalidData,

	/// Invalid input.
	InvalidInput,

	#[cfg(feature = "std")]
	Io(std::io::Error),
}

/// IO specific Result.
pub type Result<T> = core::result::Result<T, Error>;

pub trait Write {
	/// Write a buffer of data into this write.
	///
	/// All data is written at once.
	fn write(&mut self, buf: &[u8]) -> Result<()>;
}

pub trait Read {
	/// Read a data from this read to a buffer.
	///
	/// If there is not enough data in this read then `UnexpectedEof` will be returned.
	fn read(&mut self, buf: &mut [u8]) -> Result<()>;
}

pub trait Seek {
	/// Seeks relative to the current position in the stream.
	fn seek_relative(&mut self, offset: i64) -> Result<()>;
	/// Returns the current seek position from the start of the stream.
	fn stream_position(&mut self) -> Result<u64>;
	/// Returns the current length of this stream (in bytes).
	fn stream_len(&mut self) -> Result<u64>;
}

/// Reader that saves the last position.
pub struct Cursor<T> {
	inner: T,
	pos: usize,
}

impl<T> Cursor<T> {
	pub fn new(inner: T) -> Cursor<T> {
		Cursor { inner, pos: 0 }
	}

	pub fn position(&self) -> usize {
		self.pos
	}
}

impl<T: AsRef<[u8]>> Read for Cursor<T> {
	fn read(&mut self, buf: &mut [u8]) -> Result<()> {
		let slice = self.inner.as_ref();
		let remainder = slice.len() - self.pos;
		let requested = buf.len();
		if requested > remainder {
			return Err(Error::UnexpectedEof);
		}
		buf.copy_from_slice(&slice[self.pos..(self.pos + requested)]);
		self.pos += requested;
		Ok(())
	}
}

impl<T: AsRef<[u8]>> Seek for Cursor<T> {
	fn seek_relative(&mut self, offset: i64) -> Result<()> {
		let offset: usize = offset.try_into().map_err(|_| Error::InvalidInput)?;
		self.pos = self.pos.checked_add(offset).ok_or(Error::InvalidInput)?;
		Ok(())
	}

	fn stream_position(&mut self) -> Result<u64> {
		self.pos.try_into().map_err(|_| Error::InvalidInput)
	}

	fn stream_len(&mut self) -> Result<u64> {
		self.inner.as_ref().len().try_into().map_err(|_| Error::InvalidInput)
	}
}

#[cfg(not(feature = "std"))]
impl Write for alloc::vec::Vec<u8> {
	fn write(&mut self, buf: &[u8]) -> Result<()> {
		self.extend(buf);
		Ok(())
	}
}

#[cfg(feature = "std")]
impl<T: io::Read> Read for T {
	fn read(&mut self, buf: &mut [u8]) -> Result<()> {
		self.read_exact(buf).map_err(Error::Io)
	}
}

#[cfg(feature = "std")]
impl<T: io::Seek> Seek for T {
	fn seek_relative(&mut self, pos: i64) -> Result<()> {
		self.seek(std::io::SeekFrom::Current(pos)).map_err(Error::Io)?;
		Ok(())
	}

	fn stream_position(&mut self) -> Result<u64> {
		self.stream_position().map_err(Error::Io)
	}

	fn stream_len(&mut self) -> Result<u64> {
		let current_position = self.stream_position().map_err(Error::Io)?;
		let end_pos = self.seek(std::io::SeekFrom::End(0)).map_err(Error::Io)?;
		self.seek(std::io::SeekFrom::Start(current_position)).map_err(Error::Io)?;
		Ok(end_pos)
	}
}

#[cfg(feature = "std")]
impl<T: io::Write> Write for T {
	fn write(&mut self, buf: &[u8]) -> Result<()> {
		self.write_all(buf).map_err(Error::Io)
	}
}

#[cfg(test)]
mod tests {
	use super::*;

	#[test]
	fn cursor() {
		let mut cursor = Cursor::new(vec![0xFFu8, 0x7Fu8]);
		assert_eq!(cursor.position(), 0);

		let mut buf = [0u8];
		assert!(cursor.read(&mut buf[..]).is_ok());
		assert_eq!(cursor.position(), 1);
		assert_eq!(buf[0], 0xFFu8);
		assert!(cursor.read(&mut buf[..]).is_ok());
		assert_eq!(buf[0], 0x7Fu8);
		assert_eq!(cursor.position(), 2);
	}

	#[test]
	fn overflow_in_cursor() {
		let mut cursor = Cursor::new(vec![0u8]);
		let mut buf = [0, 1, 2];
		assert!(cursor.read(&mut buf[..]).is_err());
	}

	#[test]
	fn overflowing_seek() {
		let mut cursor = Cursor::new(vec![0u8, 1, 2]);

		// Seek past end works, it is impl dependent similar to the std crate.
		cursor.seek_relative(i64::MAX).unwrap();
		cursor.seek_relative(i64::MAX).unwrap();
		// This should overflow usize
		assert!(matches!(cursor.seek_relative(2).unwrap_err(), Error::InvalidInput));
	}
}