Struct bin_layout::DataView

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

This struct represents a data view for reading and writing data in a byte array. When read/write, This increment current offset by the size of the value.

Fields

data: T

offset: usize

Implementations

impl<T> DataView<T>

pub const fn new(data: T) -> DataView<T>

Examples

use data_view::DataView;

let view = DataView::new([0; 16]);

impl<T> DataView<T> where
    T: AsRef<[u8]>, 

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

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

Examples

use data_view::DataView;

let mut view = DataView::new([1, 2]);

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

pub fn read<E>(&mut self) -> Option<E> where
    E: Endian, 

Reads a value of type E: Endian from the DataView.

Examples

use data_view::DataView;

let mut view = DataView::new([0; 4]);

view.write::<u16>(42);
view.offset = 0;
assert_eq!(view.read::<u16>(), Some(42));
assert_eq!(view.read::<u32>(), None);

pub fn read_slice(&mut self, len: usize) -> Option<&[u8]>

Read slice from the current offset.

Example

use data_view::DataView;

let mut view = DataView::new([1, 2, 3]);

assert_eq!(view.read_slice(2), Some([1, 2].as_ref()));
assert_eq!(view.read_slice(3), None);

pub fn read_buf<const N: usize>(&mut self) -> Option<[u8; N]>

Create a buffer and returns it, from the current offset.

Examples

use data_view::DataView;

let mut view = DataView::new([1, 2, 3]);

assert_eq!(view.read_buf(), Some([1, 2]));
assert_eq!(view.read_buf::<3>(), None);

impl<T> DataView<T> where
    T: AsMut<[u8]>, 

pub fn write<E>(&mut self, num: E) -> Result<(), ()> where
    E: Endian, 

Writes a value of type E to the data view. where E is a type that implements Endian.

Examples

use data_view::DataView;

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

assert_eq!(view.write(42_u16), Ok(()));
assert_eq!(view.write(123_u32), Err(()));

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

Writes a slice into the data view.

Examples

use data_view::DataView;

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

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

Trait Implementations

impl<T> Clone for DataView<T> where
    T: Clone, 

fn clone(&self) -> DataView<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for DataView<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> Default for DataView<T> where
    T: Default, 

fn default() -> DataView<T>

Returns the “default value” for a type.

impl<T> From<T> for DataView<T>

fn from(data: T) -> DataView<T>

Performs the conversion.

impl<T> PartialEq<DataView<T>> for DataView<T> where
    T: PartialEq<T>, 

fn eq(&self, other: &DataView<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DataView<T>) -> bool

This method tests for !=.

impl<T> Eq for DataView<T> where
    T: Eq, 

impl<T> StructuralEq for DataView<T>

impl<T> StructuralPartialEq for DataView<T>