[−][src]Struct byteio::Reader
A convenience structure used for counting the number of bytes read.
This structure wraps an implementation of ReadBytes
. It
forwards read operations to the inner type while also maintaining a count
of the number of bytes that pass through it.
When you have finished with it, you can return the original type via the
into_inner
method.
When compiled with the std
feature this structure implements
Read
.
Examples
use byteio::{ReadBytes, ReadBytesExt, Reader}; fn main() -> byteio::Result<()> { let buf: &[u8] = &[1, 0, 2, 0, 0, 0, 3]; let mut reader = Reader::new(buf); assert_eq!(reader.try_read_u8()?, 1); assert_eq!(reader.try_read_u16_be()?, 2); assert_eq!(reader.try_read_u32_be()?, 3); assert_eq!(reader.num_bytes_read(), 7); let inner = reader.into_inner(); assert!(inner.is_empty()); Ok(()) }
Methods
impl<'a, R: ReadBytes<'a>> Reader<'a, R>
[src]
pub fn new(reader: R) -> Self
[src]
Creates a new Reader
by wrapping a ReadBytes
implementor.
Examples
use byteio::Reader; let buf = [0_u8; 2]; let mut reader = Reader::new(&buf[..]);
pub fn num_bytes_read(&self) -> usize
[src]
Retrieves the number of bytes that have been read by this Reader
.
Examples
use byteio::{ReadBytes, Reader}; let buf = [0_u8; 2]; let mut reader = Reader::new(&buf[..]); let _ = reader.read_exact(1); let _ = reader.read_exact(1); assert_eq!(reader.num_bytes_read(), 2);
pub fn into_inner(self) -> R
[src]
Consumes this Reader
and returns the original ReadBytes
implementor.
Examples
use byteio::{ReadBytes, Reader}; let buf = [0_u8; 2]; let mut reader = Reader::new(&buf[..]); let _ = reader.read_exact(1); let inner = reader.into_inner(); assert_eq!(inner.len(), 1); // the reader consumed one byte from its view of the slice
Trait Implementations
impl<'a, R: ReadBytes<'a>> ReadBytes<'a> for Reader<'a, R>
[src]
fn read_exact(&mut self, n: usize) -> &'a [u8]
[src]
fn try_read_exact(&mut self, n: usize) -> Result<&'a [u8]>
[src]
impl<'a, R: PartialEq + ReadBytes<'a>> PartialEq<Reader<'a, R>> for Reader<'a, R>
[src]
impl<'a, R: Eq + ReadBytes<'a>> Eq for Reader<'a, R>
[src]
impl<'a, R: Debug + ReadBytes<'a>> Debug for Reader<'a, R>
[src]
impl<'a, R: ReadBytes<'a>> AsRef<[u8]> for Reader<'a, R>
[src]
impl<'a, R: Clone + ReadBytes<'a>> Clone for Reader<'a, R>
[src]
ⓘImportant traits for Reader<'a, R>fn clone(&self) -> Reader<'a, R>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<'a, R: ReadBytes<'a>> Read for Reader<'a, R>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>
1.36.0[src]
Like read
, except that it reads into a slice of buffers. Read more
unsafe fn initializer(&self) -> Initializer
[src]
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
Creates an adaptor which will read at most limit
bytes from it. Read more
Auto Trait Implementations
impl<'a, R> Send for Reader<'a, R> where
R: Send,
R: Send,
impl<'a, R> Sync for Reader<'a, R> where
R: Sync,
R: Sync,
impl<'a, R> Unpin for Reader<'a, R> where
R: Unpin,
R: Unpin,
impl<'a, R> UnwindSafe for Reader<'a, R> where
R: UnwindSafe,
R: UnwindSafe,
impl<'a, R> RefUnwindSafe for Reader<'a, R> where
R: RefUnwindSafe,
R: RefUnwindSafe,
Blanket Implementations
impl<'a, R> ReadBytesExt<'a> for R where
R: ReadBytes<'a>,
[src]
R: ReadBytes<'a>,
fn read_u8(&mut self) -> u8
[src]
Reads a u8
from the underlying buffer. Read more
fn try_read_u8(&mut self) -> Result<u8>
[src]
Attempts to read a u8
from the underlying buffer. Read more
fn read_i8(&mut self) -> i8
[src]
Reads an i8
from the underlying buffer. Read more
fn try_read_i8(&mut self) -> Result<i8>
[src]
Attempts to read an i8
from the underlying buffer. Read more
fn read_u16_le(&mut self) -> u16
[src]
Reads a little endian u16
from the underlying buffer. Read more
fn read_u16_be(&mut self) -> u16
[src]
Reads a big endian u16
from the underlying buffer. Read more
fn try_read_u16_le(&mut self) -> Result<u16>
[src]
Attempts to read a little endian u16
from the underlying buffer. Read more
fn try_read_u16_be(&mut self) -> Result<u16>
[src]
Attempts to read a big endian u16
from the underlying buffer. Read more
fn read_i16_le(&mut self) -> i16
[src]
Reads a little endian i16
from the underlying buffer. Read more
fn read_i16_be(&mut self) -> i16
[src]
Reads a big endian i16
from the underlying buffer. Read more
fn try_read_i16_le(&mut self) -> Result<i16>
[src]
Attempts to read a little endian i16
from the underlying buffer. Read more
fn try_read_i16_be(&mut self) -> Result<i16>
[src]
Attempts to read a little endian i16
from the underlying buffer. Read more
fn read_u32_le(&mut self) -> u32
[src]
Reads a little endian u32
from the underlying buffer. Read more
fn read_u32_be(&mut self) -> u32
[src]
Reads a big endian u32
from the underlying buffer. Read more
fn try_read_u32_le(&mut self) -> Result<u32>
[src]
Attempts to read a little endian u32
from the underlying buffer. Read more
fn try_read_u32_be(&mut self) -> Result<u32>
[src]
Attempts to read a big endian u32
from the underlying buffer. Read more
fn read_i32_le(&mut self) -> i32
[src]
Reads a little endian i32
from the underlying buffer. Read more
fn read_i32_be(&mut self) -> i32
[src]
Reads a big endian i32
from the underlying buffer. Read more
fn try_read_i32_le(&mut self) -> Result<i32>
[src]
Attempts to read a little endian i32
from the underlying buffer. Read more
fn try_read_i32_be(&mut self) -> Result<i32>
[src]
Attempts to read a big endian i32
from the underlying buffer. Read more
fn read_u64_le(&mut self) -> u64
[src]
Reads a little endian u64
from the underlying buffer. Read more
fn read_u64_be(&mut self) -> u64
[src]
Reads a big endian u64
from the underlying buffer. Read more
fn try_read_u64_le(&mut self) -> Result<u64>
[src]
Attempts to read a little endian u64
from the underlying buffer. Read more
fn try_read_u64_be(&mut self) -> Result<u64>
[src]
Attempts to read a big endian u64
from the underlying buffer. Read more
fn read_i64_le(&mut self) -> i64
[src]
Reads a little endian i64
from the underlying buffer. Read more
fn read_i64_be(&mut self) -> i64
[src]
Reads a big endian i64
from the underlying buffer. Read more
fn try_read_i64_le(&mut self) -> Result<i64>
[src]
Attempts to read a little endian i64
from the underlying buffer. Read more
fn try_read_i64_be(&mut self) -> Result<i64>
[src]
Attempts to read a big endian i64
from the underlying buffer. Read more
fn read_u128_le(&mut self) -> u128
[src]
Reads a little endian u128
from the underlying buffer. Read more
fn read_u128_be(&mut self) -> u128
[src]
Reads a big endian u128
from the underlying buffer. Read more
fn try_read_u128_le(&mut self) -> Result<u128>
[src]
Attempts to read a little endian u128
from the underlying buffer. Read more
fn try_read_u128_be(&mut self) -> Result<u128>
[src]
Attempts to read a big endian u128
from the underlying buffer. Read more
fn read_i128_le(&mut self) -> i128
[src]
Reads a little endian i128
from the underlying buffer. Read more
fn read_i128_be(&mut self) -> i128
[src]
Reads a big endian i128
from the underlying buffer. Read more
fn try_read_i128_le(&mut self) -> Result<i128>
[src]
Attempts to read a little endian i128
from the underlying buffer. Read more
fn try_read_i128_be(&mut self) -> Result<i128>
[src]
Attempts to read a big endian i128
from the underlying buffer. Read more
fn read_f32_le(&mut self) -> f32
[src]
Reads a little endian IEEE754 f32
from the underlying buffer. Read more
fn read_f32_be(&mut self) -> f32
[src]
Reads a big endian IEEE754 f32
from the underlying buffer. Read more
fn try_read_f32_le(&mut self) -> Result<f32>
[src]
Attempts to read a little endian IEEE754 f32
from the underlying buffer. Read more
fn try_read_f32_be(&mut self) -> Result<f32>
[src]
Attempts to read a big endian IEEE754 f32
from the underlying buffer. Read more
fn read_f64_le(&mut self) -> f64
[src]
Reads a little endian IEEE754 f64
from the underlying buffer. Read more
fn read_f64_be(&mut self) -> f64
[src]
Reads a big endian IEEE754 f64
from the underlying buffer. Read more
fn try_read_f64_le(&mut self) -> Result<f64>
[src]
Attempts to read a little endian IEEE754 f64
from the underlying buffer. Read more
fn try_read_f64_be(&mut self) -> Result<f64>
[src]
Attempts to read a big endian IEEE754 f64
from the underlying buffer. Read more
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,