Struct nds::Builder

pub struct Builder { /* fields omitted */ }

Builds an NDS ROM given a directory with valid structure. A directory is valid if is_nds_dir returns Ok

Implementations

impl Builder

pub fn new<P: AsRef<Path>>(path: P) -> Result<Self, Error>

pub fn is_nds_dir<P: AsRef<Path>>(path: P) -> Result<(), Error>

Determines whether a given path is a valid NDS ROM. A valid NDS ROM directory is made when a ROM is extracted with an Extractor and includes the following:

./data/ ./overlay/ ./header.bin ./arm9.bin ./arm7.bin

Due to race conditions, the validity is not a guarantee that the directory is valid through the duration of program execution, so errors can still be thrown for missing files.

pub fn build<P: AsRef<Path>>(&self, path: P) -> Result<(), Error>

Builds a ROM and saves it to the path given. This method will return an error when the directory is missing required files, or if there is an issue reading files or saving the ROM.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the "default value" for a type.

impl Eq for Builder

impl Hash for Builder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Builder

fn cmp(&self, other: &Builder) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl PartialOrd<Builder> for Builder

fn partial_cmp(&self, other: &Builder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Builder) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Builder) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Builder) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Builder) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Builder

impl StructuralPartialEq for Builder