Struct bin_layout::Cursor

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

Fields

data: T

offset: usize

Implementations

impl<T: AsMut<[u8]>> Cursor<T>

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

Writes a slice into the data view.

Examples

use bin_layout::{Cursor, ErrorKind};

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

assert_eq!(view.write_slice([4, 2]), Ok(()));
assert_eq!(view.write_slice([1, 2, 3]), Err(ErrorKind::InsufficientBytes));
 
assert_eq!(view.data, [4, 2, 0]);
assert_eq!(view.offset, 2);

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(&mut self, len: usize) -> Result<&'de [u8]>

Read slice from the current offset.

Example

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

assert_eq!(view.read_slice(2), Ok([1, 2].as_ref()));
assert!(view.read_slice(3).is_err());

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

Performs the conversion.