Struct Reader 

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

Bounds-checked read cursor over a Bytes buffer.

Implementations

impl<'a> Reader<'a>

pub fn new(buf: &'a Bytes) -> Self

Creates a reader at the start of buf.

pub fn remaining(&self) -> usize

Number of unread bytes.

pub fn position(&self) -> usize

Current offset from the start of the buffer.

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

The unread bytes, without consuming them.

pub fn finish(&self) -> DecodeResult<()>

Fails with DecodeError::TrailingBytes unless the input is fully consumed.

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

Consumes n bytes and returns them as a borrowed slice.

pub fn skip(&mut self, n: usize) -> DecodeResult<()>

Advances past n bytes.

pub fn read_bytes(&mut self, n: usize) -> DecodeResult<Bytes>

Consumes n bytes and returns them as a zero-copy Bytes slice.

pub fn bytes_since(&self, start: usize) -> Bytes

Zero-copy slice of everything read since offset start (from Reader::position).

pub fn read_rest(&mut self) -> Bytes

Consumes and returns everything that is left (protodef restBuffer).

pub fn peek_u8(&self) -> DecodeResult<u8>

Returns the next byte without consuming it.

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

Reads an unsigned byte.

pub fn read_i8(&mut self) -> DecodeResult<i8>

Reads a signed byte.

pub fn read_bool(&mut self) -> DecodeResult<bool>

Reads a boolean. Like vanilla, any non-zero byte is true.

pub fn read_u16(&mut self) -> DecodeResult<u16>

Reads a big-endian u16.

pub fn read_i16(&mut self) -> DecodeResult<i16>

Reads a big-endian i16.

pub fn read_i32(&mut self) -> DecodeResult<i32>

Reads a big-endian i32.

pub fn read_i64(&mut self) -> DecodeResult<i64>

Reads a big-endian i64.

pub fn read_u64(&mut self) -> DecodeResult<u64>

Reads a big-endian u64.

pub fn read_f32(&mut self) -> DecodeResult<f32>

Reads a big-endian IEEE-754 f32.

pub fn read_f64(&mut self) -> DecodeResult<f64>

Reads a big-endian IEEE-754 f64.

pub fn read_uuid(&mut self) -> DecodeResult<Uuid>

Reads a UUID (two big-endian 64-bit halves).

pub fn read_varint(&mut self) -> DecodeResult<i32>

Reads a VarInt (at most 5 bytes).

Like vanilla, the unused high bits of a 5th byte are ignored; a 6th byte is an error (DecodeError::VarIntTooLong).

pub fn read_varlong(&mut self) -> DecodeResult<i64>

Reads a VarLong (at most 10 bytes).

pub fn read_len_varint(&mut self, limit: usize) -> DecodeResult<usize>

Reads a VarInt length prefix and checks it is non-negative and at most limit.

pub fn check_count( &self, count: i64, min_elem_size: usize, ) -> DecodeResult<usize>

Reads an array count of the given prefix width and validates it.

min_elem_size is the smallest number of bytes one element can occupy; when it is non-zero the count is bounded by the remaining input, so a hostile count can never cause a large allocation or a long loop.

pub fn read_byte_array(&mut self) -> DecodeResult<Bytes>

Reads a VarInt-prefixed byte array as a zero-copy slice.

pub fn read_string(&mut self) -> DecodeResult<ByteString>

Reads a VarInt-prefixed UTF-8 string as a zero-copy ByteString.

Trait Implementations

impl<'a> Clone for Reader<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Reader<'a>

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

Formats the value using the given formatter.