Struct File

pub struct File { /* private fields */ }

A memory-mapped NX file.

Implementations

impl File

pub unsafe fn open(path: &Path) -> Result<File, Error>

Opens an NX file via memory-mapping. This also checks the magic bytes in the header.

This is unsafe because it assumes the NX file is correct and UB may occur if there are mistakes.

pub fn node_count(&self) -> u32

Number of nodes in the file

pub fn root<'a>(&'a self) -> Node<'a>

Gets the root node of the file.

pub unsafe fn get_str(&self, index: u32) -> &str

Gets the string at the specified index in the string table.

pub unsafe fn get_node(&self, index: u32) -> &Node

Gets the node data at the specified index in the node table.

pub unsafe fn get_audio(&self, index: u32, length: u32) -> &[u8]

Gets the audio data at the specified index in the node table.

pub unsafe fn get_bitmap(&self, index: u32) -> &[u8]

Gets the bitmap data at the specified index in the node table.

Trait Implementations

impl Send for File

impl Sync for File