mod append; mod byte; mod ring; mod sink; mod slice; mod source; mod take; pub use self::append::AppendBuf; pub use self::byte::{ByteBuf, MutByteBuf, ROByteBuf}; pub use self::ring::RingBuf; pub use self::slice::{SliceBuf, MutSliceBuf}; pub use self::take::Take; use {ByteStr, RopeBuf}; use std::{cmp, fmt, io, ptr, usize}; /// A trait for values that provide sequential read access to bytes. pub trait Buf { /// Returns the number of bytes that can be accessed from the Buf fn remaining(&self) -> usize; /// Returns a slice starting at the current Buf position and of length /// between 0 and `Buf::remaining()`. fn bytes<'a>(&'a self) -> &'a [u8]; /// Advance the internal cursor of the Buf fn advance(&mut self, cnt: usize); /// Returns true if there are any more bytes to consume fn has_remaining(&self) -> bool { self.remaining() > 0 } fn copy_to(&mut self, dst: S) -> usize where Self: Sized { dst.copy_from(self) } /// Read bytes from the `Buf` into the given slice and advance the cursor by /// the number of bytes read. /// Returns the number of bytes read. /// /// ``` /// use bytes::{SliceBuf, Buf}; /// /// let mut buf = SliceBuf::wrap(b"hello world"); /// let mut dst = [0; 5]; /// /// buf.read_slice(&mut dst); /// assert_eq!(b"hello", &dst); /// assert_eq!(6, buf.remaining()); /// ``` fn read_slice(&mut self, dst: &mut [u8]) -> usize { let mut off = 0; let len = cmp::min(dst.len(), self.remaining()); while off < len { let cnt; unsafe { let src = self.bytes(); cnt = cmp::min(src.len(), len - off); ptr::copy_nonoverlapping( src.as_ptr(), dst[off..].as_mut_ptr(), cnt); off += src.len(); } self.advance(cnt); } len } /// Read a single byte from the `Buf` fn read_byte(&mut self) -> Option { let mut dst = [0]; if self.read_slice(&mut dst) == 0 { return None; } Some(dst[0]) } } /// A trait for values that provide sequential write access to bytes. pub trait MutBuf : Sized { /// Returns the number of bytes that can be written to the MutBuf fn remaining(&self) -> usize; /// Advance the internal cursor of the MutBuf unsafe fn advance(&mut self, cnt: usize); /// Returns true iff there is any more space for bytes to be written fn has_remaining(&self) -> bool { self.remaining() > 0 } /// Returns a mutable slice starting at the current MutBuf position and of /// length between 0 and `MutBuf::remaining()`. /// /// The returned byte slice may represent uninitialized memory. unsafe fn mut_bytes<'a>(&'a mut self) -> &'a mut [u8]; fn copy_from(&mut self, src: S) -> usize where Self: Sized { src.copy_to(self) } /// Write bytes from the given slice into the `MutBuf` and advance the /// cursor by the number of bytes written. /// Returns the number of bytes written. /// /// ``` /// use bytes::{MutSliceBuf, Buf, MutBuf}; /// /// let mut dst = [0; 6]; /// /// { /// let mut buf = MutSliceBuf::wrap(&mut dst); /// buf.write_slice(b"hello"); /// /// assert_eq!(1, buf.remaining()); /// } /// /// assert_eq!(b"hello\0", &dst); /// ``` fn write_slice(&mut self, src: &[u8]) -> usize { let mut off = 0; let len = cmp::min(src.len(), self.remaining()); while off < len { let cnt; unsafe { let dst = self.mut_bytes(); cnt = cmp::min(dst.len(), len - off); ptr::copy_nonoverlapping( src[off..].as_ptr(), dst.as_mut_ptr(), cnt); off += cnt; } unsafe { self.advance(cnt); } } len } } /* * * ===== Sink / Source ===== * */ /// A value that writes bytes from itself into a `MutBuf`. pub trait Source { fn copy_to(self, buf: &mut B) -> usize; } impl<'a> Source for &'a [u8] { fn copy_to(self, buf: &mut B) -> usize { buf.write_slice(self) } } impl Source for u8 { fn copy_to(self, buf: &mut B) -> usize { let src = [self]; buf.write_slice(&src) } } impl<'a, T: ByteStr> Source for &'a T { fn copy_to(self, buf: &mut B) -> usize { let mut src = ByteStr::buf(self); let mut res = 0; while src.has_remaining() && buf.has_remaining() { let l; unsafe { let s = src.bytes(); let d = buf.mut_bytes(); l = cmp::min(s.len(), d.len()); ptr::copy_nonoverlapping( s.as_ptr(), d.as_mut_ptr(), l); } src.advance(l); unsafe { buf.advance(l); } res += l; } res } } pub trait Sink { fn copy_from(self, buf: &mut B) -> usize; } impl<'a> Sink for &'a mut [u8] { fn copy_from(self, buf: &mut B) -> usize { buf.read_slice(self) } } impl<'a> Sink for &'a mut Vec { fn copy_from(self, buf: &mut B) -> usize { use std::slice; self.clear(); let rem = buf.remaining(); let cap = self.capacity(); // Ensure that the vec is big enough if rem > self.capacity() { self.reserve(rem - cap); } unsafe { { let dst = &mut self[..]; let cnt = buf.read_slice(slice::from_raw_parts_mut(dst.as_mut_ptr(), rem)); debug_assert!(cnt == rem); } self.set_len(rem); } rem } } /* * * ===== Read / Write ===== * */ pub trait ReadExt { fn read_buf(&mut self, buf: &mut B) -> io::Result; } impl ReadExt for T { fn read_buf(&mut self, buf: &mut B) -> io::Result { if !buf.has_remaining() { return Ok(0); } unsafe { let i = try!(self.read(buf.mut_bytes())); buf.advance(i); Ok(i) } } } pub trait WriteExt { fn write_buf(&mut self, buf: &mut B) -> io::Result; } impl WriteExt for T { fn write_buf(&mut self, buf: &mut B) -> io::Result { if !buf.has_remaining() { return Ok(0); } let i = try!(self.write(buf.bytes())); buf.advance(i); Ok(i) } } /* * * ===== Buf impls ===== * */ impl Buf for Box { fn remaining(&self) -> usize { (**self).remaining() } fn bytes(&self) -> &[u8] { (**self).bytes() } fn advance(&mut self, cnt: usize) { (**self).advance(cnt); } fn read_slice(&mut self, dst: &mut [u8]) -> usize { (**self).read_slice(dst) } } impl fmt::Debug for Box { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { write!(fmt, "Box {{ remaining: {} }}", self.remaining()) } } impl Buf for io::Cursor> { fn remaining(&self) -> usize { self.get_ref().len() - self.position() as usize } fn bytes(&self) -> &[u8] { let pos = self.position() as usize; &(&self.get_ref())[pos..] } fn advance(&mut self, cnt: usize) { let pos = self.position() as usize; let pos = cmp::min(self.get_ref().len(), pos + cnt); self.set_position(pos as u64); } } impl MutBuf for Vec { fn remaining(&self) -> usize { usize::MAX - self.len() } unsafe fn advance(&mut self, cnt: usize) { let len = self.len() + cnt; if len > self.capacity() { // Reserve additional // TODO: Should this case panic? let cap = self.capacity(); self.reserve(cap - len); } self.set_len(len); } unsafe fn mut_bytes(&mut self) -> &mut [u8] { use std::slice; if self.capacity() == self.len() { self.reserve(64); // Grow the vec } let cap = self.capacity(); let len = self.len(); let ptr = self.as_mut_ptr(); &mut slice::from_raw_parts_mut(ptr, cap)[len..] } } impl<'a> Buf for io::Cursor<&'a [u8]> { fn remaining(&self) -> usize { self.get_ref().len() - self.position() as usize } fn bytes(&self) -> &[u8] { let pos = self.position() as usize; &(&self.get_ref())[pos..] } fn advance(&mut self, cnt: usize) { let pos = self.position() as usize; let pos = cmp::min(self.get_ref().len(), pos + cnt); self.set_position(pos as u64); } } /* * * ===== Read impls ===== * */ macro_rules! impl_read { ($ty:ty) => { impl io::Read for $ty { fn read(&mut self, buf: &mut [u8]) -> io::Result { if !self.has_remaining() { return Ok(0); } Ok(self.read_slice(buf)) } } } } impl_read!(ByteBuf); impl_read!(ROByteBuf); impl_read!(RopeBuf); impl_read!(Box); macro_rules! impl_write { ($ty:ty) => { impl io::Write for $ty { fn write(&mut self, buf: &[u8]) -> io::Result { if !self.has_remaining() { return Ok(0); } Ok(self.write_slice(buf)) } fn flush(&mut self) -> io::Result<()> { Ok(()) } } } } impl_write!(MutByteBuf);