Struct bytecursor::bytecursor::ByteCursor

pub struct ByteCursor { /* fields omitted */ }

Implementations

impl ByteCursor

pub const fn new(inner: Vec<u8>) -> Self

Creates a new Bytecursor from the inner bytes it will contains. Sets the position to 0 initially.

pub fn into_inner(self) -> Vec<u8>

Consumes the Bytecursor, returning the inner bytes.

pub const fn get_ref(&self) -> &Vec<u8>

Returns an immutable reference to the inner bytes of the Bytecursor

pub fn get_mut(&mut self) -> &mut Vec<u8>

Returns a mutable reference to the inner bytes of the Bytecursor

pub const fn position(&self) -> u64

Returns the current position of the Bytecursor

pub fn set_position(&mut self, pos: u64)

Sets the position of the Bytecursor to pos

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

Reads buf.len() bytes into buf from read, advancing the Bytecursor’s position. It returns the number of bytes actually read.

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

Reads exactly buf.len() bytes into buf, throwing an error if that number of bytes was not able to be read.

Errors

Will return Err if the buffer is longer than the available bytes to read

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

Returns a byte slice containing all remaining bytes in the inner bytes after the current position of the Bytecursor.

pub fn seek(&mut self, style: &SeekFrom) -> Result<u64, String>

Seeks to the position referenced by style, returning the new position of the Bytecursor and throwing an error if the new position would be invalid. # Errors

Will return Err if one tries to seek to a negative or overflowing position

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

Writes buf.len() bytes into buf. Returns the number of bytes actually read if successful, and throws an error if there aren’t enough bytes to read. # Errors

Will return Err if the cursor position exceeds maximum possible vector length

pub fn write_all(&mut self, buf: &[u8]) -> Result<(), String>

Writes all of buf to the Bytecursor until buf is empty.

Errors

Will return Err if the cursor position exceeds maximum possible vector length or we failed to write whole buffer

Trait Implementations

impl Clone for ByteCursor

fn clone(&self) -> ByteCursor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ByteCursor

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

Formats the value using the given formatter.