Struct ReadBuf 

pub struct ReadBuf<'a> { /* private fields */ }

Cursor over an immutable byte slice with a tracked read position.

Example

use wire_codec::ReadBuf;

let mut buf = ReadBuf::new(&[0xDE, 0xAD, 0xBE, 0xEF]);
assert_eq!(buf.read_u16_be().unwrap(), 0xDEAD);
assert_eq!(buf.read_u16_be().unwrap(), 0xBEEF);
assert_eq!(buf.remaining(), 0);

Implementations

impl<'a> ReadBuf<'a>

pub const fn new(bytes: &'a [u8]) -> Self

Wrap bytes in a new cursor positioned at the start of the slice.

pub const fn position(&self) -> usize

Current read offset within the backing slice.

pub const fn remaining(&self) -> usize

Number of bytes still available for reading.

pub const fn is_empty(&self) -> bool

Whether the cursor has consumed every byte of the backing slice.

pub fn remaining_slice(&self) -> &'a [u8]

Slice of bytes that have not yet been consumed.

pub fn peek(&self, n: usize) -> Result<&'a [u8]>

Look at the next n bytes without advancing the cursor.

Errors

Returns Error::UnexpectedEof when fewer than n bytes remain.

pub fn read_bytes(&mut self, n: usize) -> Result<&'a [u8]>

Read the next n bytes and advance the cursor by n.

Errors

Returns Error::UnexpectedEof when fewer than n bytes remain.

pub fn advance(&mut self, n: usize) -> Result<()>

Advance the cursor by n bytes without returning the skipped data.

Errors

Returns Error::UnexpectedEof when fewer than n bytes remain.

pub fn read_u8(&mut self) -> Result<u8>

Read a single byte.

Errors

Returns Error::UnexpectedEof when the cursor is exhausted.

pub fn read_u16_be(&mut self) -> Result<u16>

Read a big-endian u16.

pub fn read_u16_le(&mut self) -> Result<u16>

Read a little-endian u16.

pub fn read_u32_be(&mut self) -> Result<u32>

Read a big-endian u32.

pub fn read_u32_le(&mut self) -> Result<u32>

Read a little-endian u32.

pub fn read_u64_be(&mut self) -> Result<u64>

Read a big-endian u64.

pub fn read_u64_le(&mut self) -> Result<u64>

Read a little-endian u64.

Trait Implementations

impl<'a> Clone for ReadBuf<'a>

fn clone(&self) -> ReadBuf<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for ReadBuf<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.