Struct gbfs::GBFSFilesystem

#[repr(align(4))]
#[repr(C)]
pub struct GBFSFilesystem<'a> { /* private fields */ }

A filesystem that files can be read from.

Implementations

impl<'a> GBFSFilesystem<'a>

pub const fn from_slice(data: &'a [u8]) -> Result<GBFSFilesystem<'a>, GBFSError>

Constructs a new filesystem from a GBFS-formatted byte slice.

To make lifetime management easier it’s probably a good idea to use a slice with a static lifetime here. It’s also a good idea to ensure this function is called at compile time with a const argument, to avoid having to store the filesystem index in RAM.

pub fn get_file_data_by_name(
    &self,
    str_name: &str
) -> Result<&'a [u8], GBFSError>

Returns a reference to the file data as a slice of u8’s. An error is returned if the file does not exist or the filename is invalid. All filenames longer than FILENAME_LEN characters are invalid.

pub fn get_file_data_by_name_as_u16_slice(
    &self,
    name: &str
) -> Result<&'a [u16], GBFSError>

Returns a reference to the file data as a slice of u32’s. An error is returned if the file does not exist, it’s length is not a multiple of 2 or the filename is invalid. All filenames longer than 24 characters are invalid.

pub fn get_file_data_by_name_as_u32_slice(
    &self,
    name: &str
) -> Result<&'a [u32], GBFSError>

Returns a reference to the file data as a slice of u32’s. An error is returned if the file does not exist, it’s length is not a multiple of 4 or the filename is invalid. All filenames longer than 24 characters are invalid.

Trait Implementations

impl<'a> Clone for GBFSFilesystem<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> IntoIterator for GBFSFilesystem<'a>

type Item = &'a [u8]

The type of the elements being iterated over.

type IntoIter = GBFSFilesystemIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.