Struct data_view::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: AsRef<[u8]>> DataView<T>

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::from([1, 2, 3]);

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

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::from([0; 4]);

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

pub unsafe fn read_unchecked<E: Endian>(&mut self) -> E

Reads a value of type E: Endian from the DataView, without doing bounds checking. For a safe alternative see read.

Safety

Calling this method with an out-of-bounds index is [undefined behavior]

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::from([1, 2, 3, 4]);

assert_eq!(view.read_slice(2).unwrap(), &[1, 2]);
assert_eq!(view.read_slice(2).unwrap(), &[3, 4]);

pub unsafe fn read_slice_unchecked(&mut self, len: usize) -> &[u8]

Read slice from the current offset, without doing bounds checking. For a safe alternative see read_slice.

Example

use data_view::DataView;
let mut view = DataView::from([1, 2, 3, 4]);
unsafe {
    assert_eq!(view.read_slice_unchecked(2), &[1, 2]);
    assert_eq!(view.read_slice_unchecked(2), &[3, 4]);
}

Safety

Calling this method with an out-of-bounds index is [undefined behavior] even if the resulting reference is not used.

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::from([1, 2, 3, 4]);

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

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

Returns a reference to an element or subslice, without doing bounds checking. For a safe alternative see read_buf.

Safety

Calling this method with an out-of-bounds index is [undefined behavior]

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

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

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::from([0; 2]);

view.write::<u8>(12);
view.write::<u8>(34);
assert_eq!(view.data, [12, 34]);

Panics

Panics if the offset is out of bounds.

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

Writes a slice into the data view.

Examples

use data_view::DataView;

let mut view = DataView::from([0; 4]);
view.write_slice([1, 2]);
view.write_slice([3, 4]);
assert_eq!(view.data, [1, 2, 3, 4]);

Panics

Panics if the offset is out of bounds.

Trait Implementations

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

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> Debug for DataView<T>

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

Formats the value using the given formatter.

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

fn default() -> DataView<T>

Returns the “default value” for a type.

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

fn from(data: T) -> Self

Creates a new View from a byte array. The offset is set to 0.

Examples

use data_view::DataView;

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

impl<T: PartialEq> PartialEq<DataView<T>> for DataView<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> Eq for DataView<T>

impl<T> StructuralEq for DataView<T>

impl<T> StructuralPartialEq for DataView<T>