Struct kiwi_schema::ByteBuffer

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

A Kiwi byte buffer meant for reading.

Example usage:

use std::borrow::Cow;
let mut bb = kiwi_schema::ByteBuffer::new(&[240, 159, 141, 149, 0, 133, 242, 210, 237]);
assert_eq!(bb.read_string(), Ok(Cow::Borrowed("🍕")));
assert_eq!(bb.read_var_float(), Ok(123.456));

Implementations

impl<'a> ByteBuffer<'a>

pub fn new(data: &[u8]) -> ByteBuffer<'_>

Create a new ByteBuffer that wraps the provided byte slice. The lifetime of the returned ByteBuffer must not outlive the lifetime of the byte slice.

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

Retrieves the underlying byte slice.

pub fn index(&self) -> usize

Retrieves the current index into the underlying byte slice. This starts off as 0 and ends up as self.data().len() when everything has been read.

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

Try to read a boolean value starting at the current index.

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

Try to read a byte starting at the current index.

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

Try to read a byte starting at the current index.

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

Try to read a variable-length signed 32-bit integer starting at the current index.

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

Try to read a variable-length unsigned 32-bit integer starting at the current index.

pub fn read_var_float(&mut self) -> Result<f32, ()>

Try to read a variable-length 32-bit floating-point number starting at the current index.

pub fn read_string(&mut self) -> Result<Cow<'a, str>, ()>

Try to read a UTF-8 string starting at the current index. This string is returned as a slice so it just aliases the underlying memory.

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

Try to read a variable-length signed 64-bit integer starting at the current index.

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

Try to read a variable-length unsigned 64-bit integer starting at the current index.