NdsForge.NdsElfProgramImporter Class Reference

Imports executable ARM ELF32 files into builder-ready Program and Overlay definitions. Parsing is deliberately bounded and transactional: callers receive a complete result only after every selected range is validated. More...

Static Public Member Functions
static NdsElfImportResult	Import (ReadOnlyMemory< byte > data, NdsProcessor processor, NdsElfImportOptions? options=null)
	Imports an ELF already available in memory without retaining or mutating the caller's buffer.
static async ValueTask< NdsElfImportResult >	ImportAsync (string path, NdsProcessor processor, NdsElfImportOptions? options=null, CancellationToken cancellationToken=default)
	Reads and imports a filesystem ELF after checking its length before allocation.
static async ValueTask< NdsElfImportResult >	ImportAsync (Stream stream, NdsProcessor processor, bool leaveOpen=false, NdsElfImportOptions? options=null, CancellationToken cancellationToken=default)
	Consumes ELF bytes from a stream's current position, including non-seekable sources, under a hard allocation bound. Stream ownership is explicit and independent from successful parsing.

Detailed Description

Imports executable ARM ELF32 files into builder-ready Program and Overlay definitions. Parsing is deliberately bounded and transactional: callers receive a complete result only after every selected range is validated.

Definition at line 9 of file NdsElfProgramImporter.cs.

Member Function Documentation

Import()

NdsElfImportResult NdsForge.NdsElfProgramImporter.Import ( ReadOnlyMemory< byte > data, NdsProcessor processor, NdsElfImportOptions? options = null )

inlinestatic

Imports an ELF already available in memory without retaining or mutating the caller's buffer.

Parameters

data	Complete ELF32 input.
processor	ARM9, ARM7, ARM9i, or ARM7i segment classification to select.
options	Optional resource and Overlay policy.

Returns

A detached Program and any decoded Overlay definitions.

Definition at line 16 of file NdsElfProgramImporter.cs.

ImportAsync() [1/2]

async ValueTask< NdsElfImportResult > NdsForge.NdsElfProgramImporter.ImportAsync ( Stream stream, NdsProcessor processor, bool leaveOpen = false, NdsElfImportOptions? options = null, CancellationToken cancellationToken = default )

inlinestatic

Consumes ELF bytes from a stream's current position, including non-seekable sources, under a hard allocation bound. Stream ownership is explicit and independent from successful parsing.

Parameters

stream	Readable source positioned at ELF byte zero.
processor	Processor and DS/DSi mode whose segments are selected.
leaveOpen	Whether the source remains usable after success, cancellation, or format failure.
options	Optional resource and Overlay policy.
cancellationToken	Cancels bounded buffering before parsing.

Returns

A detached Program and Overlay result.

Definition at line 70 of file NdsElfProgramImporter.cs.

ImportAsync() [2/2]

async ValueTask< NdsElfImportResult > NdsForge.NdsElfProgramImporter.ImportAsync ( string path, NdsProcessor processor, NdsElfImportOptions? options = null, CancellationToken cancellationToken = default )

inlinestatic

Reads and imports a filesystem ELF after checking its length before allocation.

Parameters

path	Input file whose contents are consumed without modification.
processor	Processor and DS/DSi mode whose segments are selected.
options	Optional resource and Overlay policy.
cancellationToken	Cancels file reading before a result escapes.

Returns

A detached Program and Overlay result independent from the closed file.

Definition at line 38 of file NdsElfProgramImporter.cs.

---

The documentation for this class was generated from the following file:

• src/NdsForge/Elf/NdsElfProgramImporter.cs