Enum NamErrorCode 

pub enum NamErrorCode {
    FileNotFound,
    FileReadError,
    UnknownExtension,
    NamJsonParseError,
    NamJsonWeightsExceedLimit,
    NamJsonTrainingTooLarge,
    NamJsonTrainingTooDeep,
    NamJsonSubmodelsExceedLimit,
    NamJsonSubmodelsTooDeep,
    NamJsonWeightNotFinite,
    NamJsonInvalidSampleRate,
    NamJsonUnsupportedTopology,
    NamJsonInvalidVersionFormat,
    NamJsonUnsupportedVersion,
    NamJsonUnsupportedMultiChannel,
    NambNonFiniteWeight,
    NambInvalidHeaderField,
    NambCrc32Mismatch,
    NambCrc32Missing,
    NambInvalidMagic,
    NambUnsupportedVersion,
    NambTruncated,
    UnsupportedArchitecture,
    TopologyDetectionFailed,
    WeightCountMismatch,
    ModelBuildFailed,
    ModelTooLarge,
    PipewireInitFailed,
    StreamConnectFailed,
    ResamplerBuildFailed,
    ResamplerChannelFull,
    SchedFifoDenied,
    CpuAffinityFailed,
    DeadlineExceeded,
    ParamChannelFull,
    InvalidGainValue,
    UnknownCommand,
    CtrlCHandlerFailed,
    IrLoadFailed,
    GcOverflow,
    GcCorrupted,
    OutOfMemory,
}

Structured error code for precise failure triage.

Each variant maps to exactly one failure scenario. The numeric code (used in the support block) follows the convention:

• E1xxx: Model loading (I/O, parse, build)
• E2xxx: PipeWire / audio (init, stream, resampler, RT)
• E3xxx: SPSC / inter-thread communication
• E4xxx: Runtime / CLI (parsing, commands)
• E5xxx: System / hardware (CPU features, memory)

Variants

FileNotFound

Model file not found on the filesystem.

FileReadError

I/O read error while accessing the model file.

UnknownExtension

Unknown file extension (expected .nam or .namb).

NamJsonParseError

Failed to parse JSON in .nam format.

NamJsonWeightsExceedLimit

JSON weights array exceeds float limit (MAX_WEIGHTS).

NamJsonTrainingTooLarge

JSON metadata.training field exceeds size limit (1 MiB).

NamJsonTrainingTooDeep

JSON metadata.training field exceeds tree depth limit.

NamJsonSubmodelsExceedLimit

JSON config.submodels array exceeds the maximum count (8).

NamJsonSubmodelsTooDeep

JSON config.submodels exceeds container recursion depth limit.

NamJsonWeightNotFinite

JSON weight value is non-finite (NaN, +Inf, -Inf).

NamJsonInvalidSampleRate

JSON sample_rate field contains an invalid value (non-finite or <= 0).

NamJsonUnsupportedTopology

JSON topology exceeds OOM safety limits (MAX_LAYERS or MAX_HIDDEN_SIZE).

NamJsonInvalidVersionFormat

JSON version string is not parseable as SemVer.

NamJsonUnsupportedVersion

JSON version is outside the supported range (min 0.5.0, max 0.7.x).

NamJsonUnsupportedMultiChannel

LSTM model has multi-channel I/O (NAM-rs supports mono only).

NambNonFiniteWeight

NAMB non-finite weight detected in binary weight section.

NambInvalidHeaderField

NAMB header field contains an invalid value (non-finite, <= 0, etc.).

NambCrc32Mismatch

.namb CRC32 checksum does not match expected value.

NambCrc32Missing

CRC32 flag missing in .namb v2+ file (mandatory).

NambInvalidMagic

Invalid .namb magic signature.

NambUnsupportedVersion

Unsupported .namb format version.

NambTruncated

Truncated .namb file (smaller than the minimum header).

UnsupportedArchitecture

Declared neural architecture is not supported (neither WaveNet nor LSTM).

TopologyDetectionFailed

WaveNet/LSTM topology not detectable from the configuration.

WeightCountMismatch

Weight count inconsistent with network geometry.

ModelBuildFailed

Generic failure building the model via the dispatcher.

ModelTooLarge

Model file exceeds the maximum allowed size (256 MiB).

PipewireInitFailed

Failed to initialize PipeWire or create context/core.

StreamConnectFailed

Failed to connect the PipeWire stream.

ResamplerBuildFailed

Failed to build the NamResampler (native Polyphase Sinc).

ResamplerChannelFull

SPSC resampler channel full (rebuild discarded).

SchedFifoDenied

Permission denied for SCHED_FIFO (no RT privileges).

CpuAffinityFailed

Failed to set CPU affinity on the DSP thread.

DeadlineExceeded

PipeWire deadline exceeded (DSP processing exceeded budget).

ParamChannelFull

CLI→DSP parameter SPSC channel full.

InvalidGainValue

Invalid gain value (not a valid f32 number).

UnknownCommand

Unknown CLI command.

CtrlCHandlerFailed

Failed to configure the Ctrl-C handler.

IrLoadFailed

Failed to load a cab-sim impulse response (WAV file).

GcOverflow

Overflow detected in the Garbage Collection (GC) channel.

GcCorrupted

Corrupted GC overflow buffer slot (inconsistent type/pointer).

OutOfMemory

Memory allocation failed (OOM) — layout overflow or allocator exhaustion.

Implementations

impl NamErrorCode

pub fn code(self) -> &'static str

Returns the numeric code in “Exxxx” format.

pub fn message(self) -> &'static str

Returns a human-readable message for GUI display.

pub fn mnemonic(self) -> &'static str

Returns the human-readable mnemonic name (SCREAMING_SNAKE_CASE) of the code.

Trait Implementations

impl Clone for NamErrorCode

fn clone(&self) -> NamErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for NamErrorCode

impl Debug for NamErrorCode

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

Formats the value using the given formatter.

impl Display for NamErrorCode

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

Formats the value using the given formatter.

impl Eq for NamErrorCode

impl Error for NamErrorCode

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl PartialEq for NamErrorCode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for NamErrorCode