Struct data_view::DataView

source · [−]

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

Expand description

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: Toffset: usize

Implementations

source

impl<T> DataView<T>

source

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

Examples

use data_view::DataView;

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

source

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

source

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());

source

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

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);

source

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);

source

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);

source

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

source

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

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(()));

source

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]);