Struct ReadCursor

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

A cursor for reading bytes from a buffer.

Implementations

impl<'a> ReadCursor<'a>

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

Create a new ReadCursor from a byte slice.

pub const fn len(&self) -> usize

Returns the number of bytes remaining.

pub const fn is_empty(&self) -> bool

Returns true if there are no bytes remaining.

pub const fn eof(&self) -> bool

Returns true if there are no bytes remaining.

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

Returns a slice of the remaining bytes.

pub const fn split_at_peek( &self, mid: usize, ) -> (ReadCursor<'a>, ReadCursor<'a>)

Returns two cursors, one with the first mid bytes and the other with the remaining bytes.

pub fn split_at(&mut self, mid: usize) -> (ReadCursor<'a>, ReadCursor<'a>)

Returns two cursors, one with the first mid bytes and the other with the remaining bytes.

The current cursor will be moved to the end.

pub const fn inner(&self) -> &[u8]

Return the inner byte slice.

pub const fn pos(&self) -> usize

Returns the current position.

pub fn read_array<const N: usize>(&mut self) -> [u8; N]

Read an array of N bytes.

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

Read a slice of n bytes.

pub fn read_remaining(&mut self) -> &[u8]

Read the remaining bytes.

pub fn read_u8(&mut self) -> u8

Read a u8.

pub fn try_read_u8(&mut self) -> Result<u8, NotEnoughBytesError>

Try to read a u8.

pub fn read_i16(&mut self) -> i16

Read a i16.

pub fn read_i16_be(&mut self) -> i16

Read a i16 in big-endian.

pub fn try_read_i16(&mut self) -> Result<i16, NotEnoughBytesError>

Try to read a i16.

pub fn try_read_i16_be(&mut self) -> Result<i16, NotEnoughBytesError>

Try to read a i16 in big-endian.

pub fn read_u16(&mut self) -> u16

Read a u16.

pub fn read_u16_be(&mut self) -> u16

Read a u16 in big-endian.

pub fn try_read_u16(&mut self) -> Result<u16, NotEnoughBytesError>

Try to read a u16.

pub fn try_read_u16_be(&mut self) -> Result<u16, NotEnoughBytesError>

Try to read a u16 in big-endian.

pub fn read_u32(&mut self) -> u32

Read a u32.

pub fn read_u32_be(&mut self) -> u32

Read a u32 in big-endian.

pub fn try_read_u32(&mut self) -> Result<u32, NotEnoughBytesError>

Try to read a u32.

pub fn try_read_u32_be(&mut self) -> Result<u32, NotEnoughBytesError>

Try to read a u32 in big-endian.

pub fn read_u64(&mut self) -> u64

Read a u64.

pub fn read_u64_be(&mut self) -> u64

Read a u64 in big-endian.

pub fn try_read_u64(&mut self) -> Result<u64, NotEnoughBytesError>

Try to read a u64.

pub fn try_read_u64_be(&mut self) -> Result<u64, NotEnoughBytesError>

Try to read a u64 in big-endian.

pub fn read_i32(&mut self) -> i32

Read a i32.

pub fn read_i32_be(&mut self) -> i32

Read a i32 in big-endian.

pub fn try_read_i32(&mut self) -> Result<i32, NotEnoughBytesError>

Try to read a i32.

pub fn try_read_i32_be(&mut self) -> Result<i32, NotEnoughBytesError>

Try to read a i32 in big-endian.

pub fn read_i64(&mut self) -> i64

Read a i64.

pub fn read_i64_be(&mut self) -> i64

Read a i64 in big-endian.

pub fn try_read_i64(&mut self) -> Result<i64, NotEnoughBytesError>

Try to read a i64.

pub fn try_read_i64_be(&mut self) -> Result<i64, NotEnoughBytesError>

Try to read a i64 in big-endian.

pub fn read_u128(&mut self) -> u128

Read a u128.

pub fn read_u128_be(&mut self) -> u128

Read a u128 in big-endian.

pub fn try_read_u128(&mut self) -> Result<u128, NotEnoughBytesError>

Try to read a u128.

pub fn try_read_u128_be(&mut self) -> Result<u128, NotEnoughBytesError>

Try to read a u128 in big-endian.

pub fn peek<const N: usize>(&mut self) -> [u8; N]

Peek at the next N bytes without consuming them.

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

Peek at the next N bytes without consuming them.

pub fn peek_u8(&mut self) -> u8

Peek a u8 without consuming it.

pub fn try_peek_u8(&mut self) -> Result<u8, NotEnoughBytesError>

Try to peek a u8 without consuming it.

pub fn peek_u16(&mut self) -> u16

Peek a u16 without consuming it.

pub fn peek_u16_be(&mut self) -> u16

Peek a big-endian u16 without consuming it.

pub fn try_peek_u16(&mut self) -> Result<u16, NotEnoughBytesError>

Try to peek a u16 without consuming it.

pub fn try_peek_u16_be(&mut self) -> Result<u16, NotEnoughBytesError>

Try to peek a big-endian u16 without consuming it.

pub fn peek_u32(&mut self) -> u32

Peek a u32 without consuming it.

pub fn peek_u32_be(&mut self) -> u32

Peek a big-endian u32 without consuming it.

pub fn try_peek_u32(&mut self) -> Result<u32, NotEnoughBytesError>

Try to peek a u32 without consuming it.

pub fn try_peek_u32_be(&mut self) -> Result<u32, NotEnoughBytesError>

Try to peek a big-endian u32 without consuming it.

pub fn peek_u64(&mut self) -> u64

Peek a u64 without consuming it.

pub fn peek_u64_be(&mut self) -> u64

Peek a big-endian u64 without consuming it.

pub fn try_peek_u64(&mut self) -> Result<u64, NotEnoughBytesError>

Try to peek a u64 without consuming it.

pub fn try_peek_u64_be(&mut self) -> Result<u64, NotEnoughBytesError>

Try to peek a big-endian u64 without consuming it.

pub fn advance(&mut self, len: usize)

Advance the cursor by len bytes.

pub const fn advanced(&'a self, len: usize) -> ReadCursor<'a>

Return a new cursor advanced by len bytes.

pub fn rewind(&mut self, len: usize)

Rewind the cursor by len bytes.

pub const fn rewinded(&'a self, len: usize) -> ReadCursor<'a>

Return a new cursor rewinded by len bytes.

Trait Implementations

impl<'a> Clone for ReadCursor<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ReadCursor<'a>

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

Formats the value using the given formatter.