Struct samply_symbols::FileContentsWrapper

pub struct FileContentsWrapper<T: FileContents> { /* private fields */ }

A wrapper for a FileContents object. The wrapper provides some convenience methods and, most importantly, implements ReadRef for &FileContentsWrapper.

Implementations

impl<T: FileContents> FileContentsWrapper<T>

pub fn new(file_contents: T) -> Self

pub fn len(&self) -> u64

pub fn is_empty(&self) -> bool

pub fn read_bytes_at(
    &self,
    offset: u64,
    size: u64
) -> FileAndPathHelperResult<&[u8]>

pub fn read_bytes_at_until(
    &self,
    range: Range<u64>,
    delimiter: u8
) -> FileAndPathHelperResult<&[u8]>

pub fn read_bytes_into(
    &self,
    buffer: &mut Vec<u8>,
    offset: u64,
    size: usize
) -> FileAndPathHelperResult<()>

Append size bytes to buffer, starting to read at offset in the file. If successful, buffer must have had its len increased exactly by size, otherwise the caller may panic.

pub fn read_entire_data(&self) -> FileAndPathHelperResult<&[u8]>

pub fn full_range(&self) -> RangeReadRef<'_, &Self>

pub fn range(&self, start: u64, size: u64) -> RangeReadRef<'_, &Self>

Trait Implementations

impl<T: FileContents> Debug for FileContentsWrapper<T>

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

Formats the value using the given formatter.

impl<'data, T: FileContents> ReadRef<'data> for &'data FileContentsWrapper<T>

fn len(self) -> Result<u64, ()>

The total size of the block of data.

fn read_bytes_at(self, offset: u64, size: u64) -> Result<&'data [u8], ()>

Get a reference to a u8 slice at the given offset.

fn read_bytes_at_until(
    self,
    range: Range<u64>,
    delimiter: u8
) -> Result<&'data [u8], ()>

Get a reference to a delimited u8 slice which starts at range.start.

fn read_bytes(self, offset: &mut u64, size: u64) -> Result<&'a [u8], ()>

Get a reference to a u8 slice at the given offset, and update the offset.

fn read<T>(self, offset: &mut u64) -> Result<&'a T, ()>where
    T: Pod,

Get a reference to a Pod type at the given offset, and update the offset.

fn read_at<T>(self, offset: u64) -> Result<&'a T, ()>where
    T: Pod,

Get a reference to a Pod type at the given offset.

fn read_slice<T>(self, offset: &mut u64, count: usize) -> Result<&'a [T], ()>where
    T: Pod,

Get a reference to a slice of a Pod type at the given offset, and update the offset.

fn read_slice_at<T>(self, offset: u64, count: usize) -> Result<&'a [T], ()>where
    T: Pod,

Get a reference to a slice of a Pod type at the given offset.

impl<'s, F: FileContents> Source<'s> for &'s FileContentsWrapper<F>

fn view(
    &mut self,
    slices: &[SourceSlice]
) -> Result<Box<dyn SourceView<'s>>, Error>

Provides a contiguous view of the source file composed of the requested position(s).