Struct symbolic_common::ByteView

pub struct ByteView<'a> { /* fields omitted */ }

A smart pointer for byte data.

This type can be used to uniformly access bytes that were created either from mmapping in a path, a vector or a borrowed slice. A byteview derefs into a &[u8] and is used in symbolic in most situations where binary files are worked with.

A ByteView can be constructed from borrowed slices, vectors or mmaped from the file system directly.

Example

let bv = ByteView::from_slice(b"1234");
assert_eq!(&*bv, b"1234");

Methods

impl<'a> ByteView<'a>

pub fn from_cow(cow: Cow<'a, [u8]>) -> Self

Constructs a ByteView from a Cow.

pub fn from_slice(buffer: &'a [u8]) -> Self

Constructs a ByteView from a byte slice.

pub fn from_vec(buffer: Vec<u8>) -> Self

Constructs a ByteView from a vector of bytes.

pub fn read<R: Read>(reader: R) -> Result<Self, Error>

Constructs a ByteView from any std::io::Reader.

This currently consumes the entire reader and stores its data in an internal buffer. Prefer ByteView::open when reading from the file system or ByteView::from_slice / ByteView::from_vec for in-memory operations. This behavior might change in the future.

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Constructs a ByteView from a file path by memory mapping the file.

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

Returns a slice of the underlying data.

Trait Implementations

impl<'_> AsRef<[u8]> for ByteView<'_>

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<'a> Clone for ByteView<'a>

fn clone(&self) -> ByteView<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ByteView<'a>

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

Formats the value using the given formatter.

impl<'_> Deref for ByteView<'_>

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'_> StableDeref for ByteView<'_>