Struct bin_layout::Cursor

pub struct Cursor<T> {
    pub data: T,
    pub offset: usize,
}

Fields

data: T

offset: usize

Implementations

impl<T: Bytes> Cursor<T>

pub fn write_slice(&mut self, slice: impl AsRef<[u8]>)

Writes a slice into the data view.

Examples

use bin_layout::{Cursor, ErrorKind};

let mut view = Cursor::new(vec![0; 3]);

view.write_slice([4, 2]);
assert_eq!(view.offset, 2);

Panics

This function may panic, if the data is slice &mut [u8], and has not enough capacity.

But If the data is vector Vec<u8>, then it may reserve extra capacity if necessary.

impl<'de> Cursor<&'de [u8]>

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

Returns remaining slice from the current offset. It doesn’t change the offset.

Examples

use bin_layout::Cursor;

let mut view = Cursor::new([1, 2].as_ref());

assert_eq!(view.remaining_slice(), &[1, 2]);
view.offset = 42;
assert!(view.remaining_slice().is_empty());

pub fn read_slice<E: Error>(&mut self, len: usize) -> Result<&'de [u8], E>

Read slice from the current offset.

Example

use bin_layout::{Cursor, ErrorKind};
let mut view = Cursor::new([1, 2, 3].as_ref());

let slice: Result<_, ()> = view.read_slice(2);
assert_eq!(slice, Ok([1, 2].as_ref()));
 
let slice: Result<_, ErrorKind> = view.read_slice(3);
assert_eq!(slice, Err(ErrorKind::InsufficientBytes));

impl<T> Cursor<T>

pub const fn new(data: T) -> Self

Trait Implementations

impl<T: Debug> Debug for Cursor<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Cursor<T>

fn default() -> Cursor<T>

Returns the “default value” for a type.

impl<T> From<T> for Cursor<T>

fn from(data: T) -> Self

Converts to this type from the input type.