Struct RomFs

pub struct RomFs<'a> { /* private fields */ }

Represents a ROM Filing System (ROMFS), as backed by a byte slice in memory.

Implementations

impl<'a> RomFs<'a>

pub fn new(contents: &'a [u8]) -> Result<RomFs<'a>, Error>

Mount a ROMFS using a given block of RAM

pub fn find(&self, file_name: &str) -> Option<Entry<&str, &[u8]>>

Find a file in the ROMFS, by name.

pub fn construct<S, T>( buffer: &mut [u8], entries: &[Entry<S, T>], ) -> Result<usize, Error>

where S: AsRef<str>, T: AsRef<[u8]>,

Construct a ROMFS into the given buffer.

Tells you how many bytes it used of the given buffer.

The buffer must be large enough otherwise an error is returned - see Self::size_required to calculate the size of buffer required.

pub fn construct_into<S, T, SINK>( buffer: &mut SINK, entries: &[Entry<S, T>], ) -> Result<usize, Error>

where S: AsRef<str>, T: AsRef<[u8]>, SINK: Write,

Construct a ROMFS into the given embedded-io byte sink.

Tells you how many bytes it wrote to the given buffer.

pub fn size_required<S, T>(entries: &[Entry<S, T>]) -> usize

where S: AsRef<str>, T: AsRef<[u8]>,

Tells you how many bytes you need to make a ROMFS from these entries.

Trait Implementations

impl<'a> IntoIterator for &'a RomFs<'a>

type Item = Result<Entry<&'a str, &'a [u8]>, Error>

The type of the elements being iterated over.

type IntoIter = RomFsEntryIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for RomFs<'a>

type Item = Result<Entry<&'a str, &'a [u8]>, Error>

The type of the elements being iterated over.

type IntoIter = RomFsEntryIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.