#![no_std] #![feature(never_type)] #[cfg(feature = "alloc")] extern crate alloc; #[cfg(feature = "byteorder")] extern crate byteorder; pub mod cursor; #[cfg(feature = "byteorder")] pub mod proto; use core::fmt::{Display, Formatter}; pub use cursor::Cursor; #[cfg(all(feature = "byteorder", feature = "alloc"))] pub use proto::ReadStringError; #[cfg(feature = "byteorder")] pub use proto::{ProtoRead, ProtoWrite}; #[derive(Debug, Clone, PartialEq)] pub enum Error { UnexpectedEnd, Other(T), } impl From for Error { fn from(value: T) -> Error { Error::Other(value) } } impl Display for Error { fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), core::fmt::Error> { match self { Error::UnexpectedEnd => write!(f, "unexpected end of stream"), Error::Other(other) => write!(f, "other IO error: {}", other), } } } pub trait Read { type ReadError; /// Pull some bytes from this source into the specified buffer, returning /// how many bytes were read. fn read(&mut self, buf: &mut [u8]) -> Result; /// Read the exact number of bytes required to fill `buf`. fn read_exact(&mut self, mut buf: &mut [u8]) -> Result<(), Error> { while !buf.is_empty() { let read_bytes = self.read(buf)?; if read_bytes == 0 { return Err(Error::UnexpectedEnd); } buf = &mut { buf }[read_bytes..]; } Ok(()) } } impl<'a, T: Read> Read for &'a mut T { type ReadError = T::ReadError; fn read(&mut self, buf: &mut [u8]) -> Result { T::read(self, buf) } } pub trait Write { type WriteError; type FlushError; /// Write a buffer into this object, returning how many bytes were written. fn write(&mut self, buf: &[u8]) -> Result; /// Flush this output stream, ensuring that all intermediately buffered contents /// reach their destination. fn flush(&mut self) -> Result<(), Self::FlushError>; /// Attempts to write an entire buffer into `self`. fn write_all(&mut self, mut buf: &[u8]) -> Result<(), Error> { while buf.len() > 0 { let written_bytes = self.write(buf)?; if written_bytes == 0 { return Err(Error::UnexpectedEnd); } buf = &buf[written_bytes..]; } Ok(()) } /// Hints the writer how much bytes will be written after call to this function. /// /// At least `min` bytes should be written after the call to this function and /// if `max` is `Some(x)` than at most `x` bytes should be written. fn size_hint(&mut self, _min: usize, _max: Option) {} } impl<'a, T: Write> Write for &'a mut T { type WriteError = T::WriteError; type FlushError = T::FlushError; fn write(&mut self, buf: &[u8]) -> Result { T::write(self, buf) } fn flush(&mut self) -> Result<(), Self::FlushError> { T::flush(self) } fn size_hint(&mut self, min: usize, max: Option) { T::size_hint(self, min, max) } } impl<'a> Write for &'a mut [u8] { type WriteError = !; type FlushError = !; fn write(&mut self, buf: &[u8]) -> Result { let len = buf.len().min(self.len()); self[..len].copy_from_slice(&buf[..len]); Ok(len) } #[inline] fn flush(&mut self) -> Result<(), Self::FlushError> { Ok(()) } } #[cfg(feature = "alloc")] impl<'a> Write for alloc::vec::Vec { type WriteError = !; type FlushError = !; fn write(&mut self, buf: &[u8]) -> Result { self.extend_from_slice(buf); Ok(buf.len()) } #[inline] fn flush(&mut self) -> Result<(), Self::FlushError> { Ok(()) } }