Type Definition tranche::BufTranche

type BufTranche<'a> = Tranche<'a, u8>;

A tranche of bytes, equipped with many convenience methods.

This type implements std::io::Read and std::io::BufRead when the std feature is enabled.

Methods

impl<'a> BufTranche<'a>

pub fn take_front_as<T>(
    &mut self,
    n: usize
) -> Result<Tranche<'a, T>, UnexpectedEndError> where
    T: AlwaysAligned + AlwaysValid + Immutable, 

Takes the first n elements of type T out of the tranche.

Returns a new tranche with the first n elements of self viewed as a tranche of T values, or Err(_) if it is not long enough. The error details are expressed in terms of the size of T, not the size of u8.

Examples

let mut v = BufTranche::new(&[1, 2, 3, 4, 5, 6, 7, 8, 9]);
let four_pairs = v.take_front_as::<[u8; 2]>(4).unwrap();
assert_eq!(four_pairs.as_slice(), &[[1, 2], [3, 4], [5, 6], [7, 8]]);
assert_eq!(v.as_slice(), &[9]);

let err = v.take_front_as::<[u8; 2]>(1).unwrap_err();
assert_eq!(err.needed(), 1);
assert_eq!(err.len(), 0);

impl<'_> BufTranche<'_>

pub fn take_u8(&mut self) -> Result<u8, UnexpectedEndError>

Takes the first u8 out of the tranche.

Returns Err(_) if self is not long enough.

pub fn take_i8(&mut self) -> Result<i8, UnexpectedEndError>

Takes the first i8 out of the tranche.

Returns Err(_) if self is not long enough.

pub fn take_u16_ne(&mut self) -> Result<u16, UnexpectedEndError>

Returns a u16 by taking the first mem::size_of::<u16>() bytes out of the tranche in native endian order.

Returns Err(_) if self is not long enough.

pub fn take_u16_le(&mut self) -> Result<u16, UnexpectedEndError>

Returns a u16 by taking the first mem::size_of::<u16>() bytes out of the tranche in little endian order.

Returns Err(_) if self is not long enough.

pub fn take_u16_be(&mut self) -> Result<u16, UnexpectedEndError>

Returns a u16 by taking the first mem::size_of::<u16>() bytes out of the tranche in big endian order.

Returns Err(_) if self is not long enough.

pub fn take_i16_ne(&mut self) -> Result<i16, UnexpectedEndError>

Returns a i16 by taking the first mem::size_of::<i16>() bytes out of the tranche in native endian order.

Returns Err(_) if self is not long enough.

pub fn take_i16_le(&mut self) -> Result<i16, UnexpectedEndError>

Returns a i16 by taking the first mem::size_of::<i16>() bytes out of the tranche in little endian order.

Returns Err(_) if self is not long enough.

pub fn take_i16_be(&mut self) -> Result<i16, UnexpectedEndError>

Returns a i16 by taking the first mem::size_of::<i16>() bytes out of the tranche in big endian order.

Returns Err(_) if self is not long enough.

pub fn take_u32_ne(&mut self) -> Result<u32, UnexpectedEndError>

Returns a u32 by taking the first mem::size_of::<u32>() bytes out of the tranche in native endian order.

Returns Err(_) if self is not long enough.

pub fn take_u32_le(&mut self) -> Result<u32, UnexpectedEndError>

Returns a u32 by taking the first mem::size_of::<u32>() bytes out of the tranche in little endian order.

Returns Err(_) if self is not long enough.

pub fn take_u32_be(&mut self) -> Result<u32, UnexpectedEndError>

Returns a u32 by taking the first mem::size_of::<u32>() bytes out of the tranche in big endian order.

Returns Err(_) if self is not long enough.

pub fn take_i32_ne(&mut self) -> Result<i32, UnexpectedEndError>

Returns a i32 by taking the first mem::size_of::<i32>() bytes out of the tranche in native endian order.

Returns Err(_) if self is not long enough.

pub fn take_i32_le(&mut self) -> Result<i32, UnexpectedEndError>

Returns a i32 by taking the first mem::size_of::<i32>() bytes out of the tranche in little endian order.

Returns Err(_) if self is not long enough.

pub fn take_i32_be(&mut self) -> Result<i32, UnexpectedEndError>

Returns a i32 by taking the first mem::size_of::<i32>() bytes out of the tranche in big endian order.

Returns Err(_) if self is not long enough.

pub fn take_u64_ne(&mut self) -> Result<u64, UnexpectedEndError>

Returns a u64 by taking the first mem::size_of::<u64>() bytes out of the tranche in native endian order.

Returns Err(_) if self is not long enough.

pub fn take_u64_le(&mut self) -> Result<u64, UnexpectedEndError>

Returns a u64 by taking the first mem::size_of::<u64>() bytes out of the tranche in little endian order.

Returns Err(_) if self is not long enough.

pub fn take_u64_be(&mut self) -> Result<u64, UnexpectedEndError>

Returns a u64 by taking the first mem::size_of::<u64>() bytes out of the tranche in big endian order.

Returns Err(_) if self is not long enough.

pub fn take_i64_ne(&mut self) -> Result<i64, UnexpectedEndError>

Returns a i64 by taking the first mem::size_of::<i64>() bytes out of the tranche in native endian order.

Returns Err(_) if self is not long enough.

pub fn take_i64_le(&mut self) -> Result<i64, UnexpectedEndError>

Returns a i64 by taking the first mem::size_of::<i64>() bytes out of the tranche in little endian order.

Returns Err(_) if self is not long enough.

pub fn take_i64_be(&mut self) -> Result<i64, UnexpectedEndError>

Returns a i64 by taking the first mem::size_of::<i64>() bytes out of the tranche in big endian order.

Returns Err(_) if self is not long enough.

pub fn take_u128_ne(&mut self) -> Result<u128, UnexpectedEndError>

Returns a u128 by taking the first mem::size_of::<u128>() bytes out of the tranche in native endian order.

Returns Err(_) if self is not long enough.

pub fn take_u128_le(&mut self) -> Result<u128, UnexpectedEndError>

Returns a u128 by taking the first mem::size_of::<u128>() bytes out of the tranche in little endian order.

Returns Err(_) if self is not long enough.

pub fn take_u128_be(&mut self) -> Result<u128, UnexpectedEndError>

Returns a u128 by taking the first mem::size_of::<u128>() bytes out of the tranche in big endian order.

Returns Err(_) if self is not long enough.

pub fn take_i128_ne(&mut self) -> Result<i128, UnexpectedEndError>

Returns a i128 by taking the first mem::size_of::<i128>() bytes out of the tranche in native endian order.

Returns Err(_) if self is not long enough.

pub fn take_i128_le(&mut self) -> Result<i128, UnexpectedEndError>

Returns a i128 by taking the first mem::size_of::<i128>() bytes out of the tranche in little endian order.

Returns Err(_) if self is not long enough.

pub fn take_i128_be(&mut self) -> Result<i128, UnexpectedEndError>

Returns a i128 by taking the first mem::size_of::<i128>() bytes out of the tranche in big endian order.

Returns Err(_) if self is not long enough.

pub fn take_usize_ne(&mut self) -> Result<usize, UnexpectedEndError>

Returns a usize by taking the first mem::size_of::<usize>() bytes out of the tranche in native endian order.

Returns Err(_) if self is not long enough.

pub fn take_usize_le(&mut self) -> Result<usize, UnexpectedEndError>

Returns a usize by taking the first mem::size_of::<usize>() bytes out of the tranche in little endian order.

Returns Err(_) if self is not long enough.

pub fn take_usize_be(&mut self) -> Result<usize, UnexpectedEndError>

Returns a usize by taking the first mem::size_of::<usize>() bytes out of the tranche in big endian order.

Returns Err(_) if self is not long enough.

pub fn take_isize_ne(&mut self) -> Result<isize, UnexpectedEndError>

Returns a isize by taking the first mem::size_of::<isize>() bytes out of the tranche in native endian order.

Returns Err(_) if self is not long enough.

pub fn take_isize_le(&mut self) -> Result<isize, UnexpectedEndError>

Returns a isize by taking the first mem::size_of::<isize>() bytes out of the tranche in little endian order.

Returns Err(_) if self is not long enough.

pub fn take_isize_be(&mut self) -> Result<isize, UnexpectedEndError>

Returns a isize by taking the first mem::size_of::<isize>() bytes out of the tranche in big endian order.

Returns Err(_) if self is not long enough.

Trait Implementations

impl<'_> BufRead for BufTranche<'_>

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, len: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes into buf until the delimiter byte or EOF is reached.

fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

impl<'_> Read for BufTranche<'_>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.