Struct GenieCode 

pub struct GenieCode { /* private fields */ }

A decoded Game Genie code: an address in $8000-$FFFF, a substitute data byte, and an optional compare byte (present only for 8-character codes).

Implementations

impl GenieCode

pub fn new(code: &str) -> Result<Self, GenieError>

Decode a 6- or 8-character Game Genie code.

The input is case-insensitive; code returns the canonical upper-case form.

Errors

Returns GenieError::InvalidLength if the code is not 6 or 8 characters, or GenieError::InvalidCharacter if it contains a letter outside the Game Genie alphabet.

pub fn code(&self) -> &str

The canonical upper-case code string.

pub const fn addr(&self) -> u16

The PRG address ($8000-$FFFF) this code substitutes.

pub const fn data(&self) -> u8

The substitute data byte.

pub const fn compare(&self) -> Option<u8>

The compare byte (8-character codes only).

pub const fn read(&self, original: u8) -> u8

Apply this code to a byte read from addr.

For a 6-character code the substitute data always replaces original. For an 8-character code the substitution only fires when original equals the compare byte; otherwise the original byte passes through (so the code targets one specific bank).

Trait Implementations

impl Clone for GenieCode

fn clone(&self) -> GenieCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenieCode

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

Formats the value using the given formatter.

impl Display for GenieCode

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

Formats the value using the given formatter.

impl PartialEq for GenieCode

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for GenieCode

impl StructuralPartialEq for GenieCode