Enum OpllStateError 

#[non_exhaustive]
pub enum OpllStateError {
    Truncated(usize),
    UnsupportedVersion(u8),
    ChipTypeMismatch {
        got: u8,
        want: u8,
    },
    InvalidEgState(u8),
}

Errors returned by Opll::restore.

Deliberately its own type rather than ApuSnapshotError: the OPLL blob does not ride in the APU section of a save state. It rides in the mapper section of whichever board carries the chip (VRC7 today), which is versioned independently of APU_SNAPSHOT_VERSION. Sharing an error type would imply a coupling between two schemas that must be free to move apart.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Truncated(usize)

Blob is shorter than the schema declares.

UnsupportedVersion(u8)

The blob’s version byte is not understood by this build.

ChipTypeMismatch

The blob was written by a differently-configured chip (YM2413 state restored into a VRC7 instance, or the reverse). The patch ROM differs between them, so the slot patches would be reinterpreted against the wrong instrument set.

Fields

got: u8

The tag read from the blob.

want: u8

The tag this instance was constructed with.

InvalidEgState(u8)

An envelope-generator state tag outside the six defined variants.

Trait Implementations

impl Debug for OpllStateError

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

Formats the value using the given formatter.

impl Display for OpllStateError

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

Formats the value using the given formatter.

impl Error for OpllStateError

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.