Struct byte_array::ByteArray

pub struct ByteArray { /* fields omitted */ }

An object that can read and store time series data.

Examples

use byte_array::ByteArray;

let mut ba = ByteArray::new();

// Write
ba <<= &3.14;
ba.write(&(1234 as u16));

// Read
ba.seek_first();
assert_eq!(3.14, ba.read::<f64>());
assert_eq!(1234, ba.read_safe::<u16>().unwrap());

Methods

impl ByteArray

pub fn new() -> Self

Creates an empty ByteArray.

pub fn read<T>(&mut self) -> T where
    T: BinaryBuilder, 

Gets the data of the specified type in the ByteArray.

But, the data to be read must implement BinaryBuilder trait.

Panics

Panics when unexpected EOF.

pub fn read_safe<T>(&mut self) -> Option<T> where
    T: BinaryBuilder, 

Gets the data of the specified type in the ByteArray safely.

But, the data to be read must implement BinaryBuilder trait.

pub fn write<T>(&mut self, value: &T) where
    T: BinaryBuilder, 

Adds data to the ByteArray.

But, the data to be read must implement BinaryBuilder trait.

pub fn seek_first(&mut self)

Starts reading the data stored in the ByteArray from the beginning.

pub fn seek_last(&mut self)

Makes the ByteArray ready for adding data.

pub fn seek_next(&mut self, stride: usize) -> Option<()>

Skips as many bytes as you want safely.

pub fn as_vec(&mut self) -> &mut Vec<u8>

Gets the actual data stored in the ByteArray.

pub fn len(&self) -> usize

Gets the number of bytes of data stored in the ByteArray.

pub fn bytes_available(&self) -> usize

Gets the byte distance from the end of the data to the current read.

pub const fn now(&self) -> usize

Gets the byte distance from the start of the data to the current read.

Trait Implementations

impl BinaryBuilder for ByteArray

fn new() -> Self

Creates an empty Data.

fn from_raw(ba: &mut ByteArray) -> Option<Self>

Gets the data of the specified type in the ByteArray.

fn to_raw(&self, ba: &mut Self)

Adds data to the ByteArray.

impl<'a, T> ShlAssign<&'a T> for ByteArray where
    T: BinaryBuilder, 

fn shl_assign(&mut self, rhs: &'a T)

Performs the <<= operation.

impl<'a, T, '_> ShlAssign<&'a T> for &'_ mut ByteArray where
    T: BinaryBuilder, 

fn shl_assign(&mut self, rhs: &'a T)

Performs the <<= operation.