Struct File 

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

A file loaded from ROM or data dir into the memory.

Returned by [rom::load] and [data::load] which requires a pre-allocated buffer of the right size. If the file size is deterimed dynamically, you might want to use [rom::load_buf] and [data::load_buf] instead (which will take care of the dynamic allocation).

Implementations

impl<'a> File<'a>

pub unsafe fn from_bytes(b: &'a [u8]) -> Self

Construct File from raw bytes.

The main purpose of this function is to support convering File to and from “basic” types, which might be required for implementing some language interpreters (Lua, Python, etc) for Firefly in Rust.

Safety

This function allows bypassing type safety and constructing Image and Font in runtime. Don’t do that. Relying on internal representation of file formats might make your app incompatible with future Firefly runtimes. If you need to modify an in-memory image, use Canvas instead.

pub const fn data(&self) -> &[u8]

Access the raw data in the file.

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

Alias for File::data.

pub const fn as_font(&self) -> Font<'_>

Interpret the file as a font.

pub const fn as_image(&self) -> Image<'_>

Interpret the file as an image.

Trait Implementations

impl<'a> From<File<'a>> for Font<'a>

fn from(value: File<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<File<'a>> for Image<'a>

fn from(value: File<'a>) -> Self

Converts to this type from the input type.