rompatcher

package module

Go to main page

Versions in this module

v1

v1.0.0

Sep 3, 2026

Changes in this version

type APSGBAPatch

+ Records []apsGBARecord

type APSN64Patch

+ Records []apsRecord

type BDFPatch

+ Records []bdfRecord

type BPSPatch

+ Actions []bpsAction

type IPS32Patch

+ Records []ipsRecord

type IPSPatch

+ Records []ipsRecord

type PMSRPatch

+ Records []pmsrRecord

type PPFPatch

+ Records []ppfRecord

type RUPPatch

+ Files []rupFile

type UPSPatch

+ Records []upsRecord

v0

v0.1.1

Sep 4, 2026

Changes in this version

+ var ErrAmbiguousArchive = errors.New("rompatcher: archive contains multiple candidate entries")

+ var ErrInvalidPatch = errors.New("rompatcher: invalid patch")

+ var ErrOutputTooLarge = errors.New("rompatcher: size limit exceeded")

+ var ErrPatchMismatch = errors.New("rompatcher: patch checksum mismatch")

+ var ErrSourceMismatch = errors.New("rompatcher: source does not match patch")

+ var ErrTargetMismatch = errors.New("rompatcher: patched output does not match patch")

+ var ErrUnexpectedEnd = errors.New("rompatcher: unexpected end of patch")

+ var ErrUnknownFormat = errors.New("rompatcher: unknown patch format")

+ var ErrUnsupported = errors.New("rompatcher: operation is not supported by this format")

+ func AdditionalChecksum(data []byte, name string) string

+ func Adler32(data []byte) uint32

+ func Apply(source, patchData []byte, options ApplyOptions) ([]byte, error)

+ func ApplyFile(sourcePath, patchPath, outputPath string, opts ApplyOptions) error

+ func ApplyFileContext(ctx context.Context, sourcePath, patchPath, outputPath string, ...) error

+ func ApplyParsedWithOptions(source []byte, p Patch, opts ApplyOptions) ([]byte, error)

+ func ApplyReaderAt(ctx context.Context, source io.ReaderAt, sourceSize int64, patch io.ReaderAt, ...) (int64, error)

+ func ApplyWithOptions(source, patchData []byte, opts ApplyOptions) ([]byte, error)

+ func CRC16(data []byte) uint16

+ func CRC32(data []byte) uint32

+ func CreateFile(originalPath, modifiedPath, outputPath string, format Format, ...) error

+ func CreateFileContext(ctx context.Context, originalPath, modifiedPath, outputPath string, ...) error

+ func CreateReaderAt(ctx context.Context, original io.ReaderAt, originalSize int64, ...) (int64, error)

+ func DefaultPatchedPath(sourcePath string) string

+ func ExtractZIP(path, entry string, kind InputKind, maxSize uint64, dst io.Writer) (string, error)

+ func FixROMChecksum(data []byte, name string) bool

+ func MD5(data []byte) string

+ func ReadZIP(path, entry string, kind InputKind, maxSize uint64) ([]byte, string, error)

+ func ReadZIPBytes(data []byte, entry string, kind InputKind, maxSize uint64) ([]byte, string, error)

+ func SHA1(data []byte) string

+ func WriteFileAtomic(path string, data []byte) error

+ type APSGBAPatch struct

+ SourceSize uint32

+ TargetSize uint32

+ func (*APSGBAPatch) Format() Format

+ func (APSGBAPatch) Description() string

+ func (p *APSGBAPatch) Apply(source []byte, options ApplyOptions) ([]byte, error)

+ func (p *APSGBAPatch) MarshalBinary() ([]byte, error)

+ func (p *APSGBAPatch) ValidateSource(source []byte) bool

+ func (p *APSGBAPatch) ValidationInfo() *ValidationInfo

+ type APSN64Patch struct

+ CartCRC [8]byte

+ CartID string

+ Encoding byte

+ HeaderType byte

+ OriginalFormat byte

+ Pad [5]byte

+ PatchDescription string

+ TargetSize uint32

+ func (*APSN64Patch) Format() Format

+ func (p *APSN64Patch) Apply(source []byte, options ApplyOptions) ([]byte, error)

+ func (p *APSN64Patch) Description() string

+ func (p *APSN64Patch) MarshalBinary() ([]byte, error)

+ func (p *APSN64Patch) ValidateSource(source []byte) bool

+ func (p *APSN64Patch) ValidationInfo() *ValidationInfo

+ type ApplyOptions struct

+ AddHeader bool

+ Context context.Context

+ FixChecksum bool

+ MaxOutputSize uint64

+ Progress func(Progress)

+ RemoveHeader bool

+ SourceName string

+ Validate bool

+ type ArchiveEntry struct

+ CompressedSize uint64

+ Name string

+ PatchCandidate bool

+ Size uint64

+ SourceCandidate bool

+ func ListZIP(path string) ([]ArchiveEntry, error)

+ func ListZIPBytes(data []byte) ([]ArchiveEntry, error)

+ type ArtifactInfo struct

+ Hashes map[string]string

+ Size *uint64

+ type BDFPatch struct

+ TargetSize uint64

+ func (*BDFPatch) Format() Format

+ func (*BDFPatch) MarshalBinary() ([]byte, error)

+ func (BDFPatch) Description() string

+ func (BDFPatch) ValidateSource([]byte) bool

+ func (BDFPatch) ValidationInfo() *ValidationInfo

+ func (p *BDFPatch) Apply(source []byte, options ApplyOptions) ([]byte, error)

+ type BPSPatch struct

+ Metadata string

+ PatchCRC uint32

+ SourceCRC uint32

+ SourceSize uint64

+ TargetCRC uint32

+ TargetSize uint64

+ func (*BPSPatch) Format() Format

+ func (p *BPSPatch) Apply(source []byte, options ApplyOptions) ([]byte, error)

+ func (p *BPSPatch) Description() string

+ func (p *BPSPatch) MarshalBinary() ([]byte, error)

+ func (p *BPSPatch) ValidateSource(source []byte) bool

+ func (p *BPSPatch) ValidationInfo() *ValidationInfo

+ type ChainResult struct

+ Output []byte

+ Steps []ChainStep

+ func ApplyChain(source []byte, patches [][]byte, opts ApplyOptions) (ChainResult, error)

+ func ApplyFileChain(sourcePath string, patchPaths []string, outputPath string, opts ApplyOptions) (ChainResult, error)

+ func ApplyFileChainContext(ctx context.Context, sourcePath string, patchPaths []string, outputPath string, ...) (result ChainResult, err error)

+ type ChainStep struct

+ Index int

+ Inspection Inspection

+ Output ArtifactInfo

+ type CreateOptions struct

+ BPSDelta bool

+ Context context.Context

+ Description string

+ MaxPatchSize uint64

+ Metadata map[string]string

+ Progress func(Progress)

+ SourceName string

+ type DryRunResult struct

+ Inspection Inspection

+ Output ArtifactInfo

+ SourceValid *bool

+ func DryRun(source, patchData []byte, opts ApplyOptions) (DryRunResult, error)

+ type Format string

+ const FormatAPSGBA

+ const FormatAPSN64

+ const FormatBDF

+ const FormatBPS

+ const FormatEBP

+ const FormatIPS

+ const FormatIPS32

+ const FormatPMSR

+ const FormatPPF

+ const FormatRUP

+ const FormatUPS

+ const FormatVCDIFF

+ type HashInfo struct

+ CRC32 string

+ MD5 string

+ SHA1 string

+ Size int64

+ func HashBytes(data []byte) HashInfo

+ func HashReader(ctx context.Context, r io.Reader) (HashInfo, error)

+ type HeaderInfo struct

+ Name string

+ Size int

+ func AddHeader(data []byte, name string) ([]byte, *HeaderInfo)

+ func CanAddHeader(data []byte, name string) *HeaderInfo

+ func DetectHeader(data []byte, name string) *HeaderInfo

+ func RemoveHeader(data []byte, name string) (header, rom []byte, info *HeaderInfo)

+ type IPS32Patch struct

+ HasTruncate bool

+ Truncate uint32

+ func (*IPS32Patch) Format() Format

+ func (IPS32Patch) Description() string

+ func (IPS32Patch) ValidateSource([]byte) bool

+ func (IPS32Patch) ValidationInfo() *ValidationInfo

+ func (p *IPS32Patch) Apply(source []byte, options ApplyOptions) ([]byte, error)

+ func (p *IPS32Patch) MarshalBinary() ([]byte, error)

+ type IPSPatch struct

+ HasTruncate bool

+ Metadata map[string]string

+ Truncate int

+ func (IPSPatch) ValidateSource([]byte) bool

+ func (IPSPatch) ValidationInfo() *ValidationInfo

+ func (p *IPSPatch) Apply(source []byte, options ApplyOptions) ([]byte, error)

+ func (p *IPSPatch) Description() string

+ func (p *IPSPatch) Format() Format

+ func (p *IPSPatch) MarshalBinary() ([]byte, error)

+ type InputKind string

+ const InputAny

+ const InputPatch

+ const InputSource

+ type Inspection struct

+ CanCreate bool

+ Description string

+ Format Format

+ Limitations []string

+ Metadata map[string]string

+ RecordCount int

+ RecordCountKnown bool

+ Reversible bool

+ Source ArtifactInfo

+ Target ArtifactInfo

+ Validation *ValidationInfo

+ func Inspect(data []byte) (Inspection, error)

+ func InspectParsed(p Patch) Inspection

+ type PMSRPatch struct

+ TargetSize int

+ func (*PMSRPatch) Format() Format

+ func (*PMSRPatch) MarshalBinary() ([]byte, error)

+ func (*PMSRPatch) ValidateSource(source []byte) bool

+ func (*PMSRPatch) ValidationInfo() *ValidationInfo

+ func (PMSRPatch) Description() string

+ func (p *PMSRPatch) Apply(source []byte, options ApplyOptions) ([]byte, error)

+ type PPFPatch struct

+ BlockCheck []byte

+ FileID string

+ ImageType byte

+ InputSize uint32

+ PatchDescription string

+ Undo bool

+ Version int

+ func (*PPFPatch) Format() Format

+ func (p *PPFPatch) Apply(source []byte, options ApplyOptions) ([]byte, error)

+ func (p *PPFPatch) Description() string

+ func (p *PPFPatch) MarshalBinary() ([]byte, error)

+ func (p *PPFPatch) ValidateSource(source []byte) bool

+ func (p *PPFPatch) ValidationInfo() *ValidationInfo

+ type Patch interface

+ Apply func(source []byte, options ApplyOptions) ([]byte, error)

+ Description func() string

+ Format func() Format

+ MarshalBinary func() ([]byte, error)

+ ValidateSource func(source []byte) bool

+ ValidationInfo func() *ValidationInfo

+ func Create(original, modified []byte, format Format, opts *CreateOptions) (Patch, error)

+ func Parse(data []byte) (Patch, error)

+ type Progress struct

+ Completed int64

+ Format Format

+ Phase string

+ Total int64

+ type RUPPatch struct

+ Author string

+ Date string

+ Genre string

+ Language string

+ PatchDescription string

+ TextEncoding byte

+ Title string

+ Version string

+ Web string

+ func (*RUPPatch) Format() Format

+ func (p *RUPPatch) Apply(source []byte, options ApplyOptions) ([]byte, error)

+ func (p *RUPPatch) Description() string

+ func (p *RUPPatch) MarshalBinary() ([]byte, error)

+ func (p *RUPPatch) ValidateSource(source []byte) bool

+ func (p *RUPPatch) ValidationInfo() *ValidationInfo

+ type UPSPatch struct

+ SourceCRC uint32

+ SourceSize uint64

+ TargetCRC uint32

+ TargetSize uint64

+ func (*UPSPatch) Format() Format

+ func (UPSPatch) Description() string

+ func (p *UPSPatch) Apply(source []byte, options ApplyOptions) ([]byte, error)

+ func (p *UPSPatch) MarshalBinary() ([]byte, error)

+ func (p *UPSPatch) ValidateSource(source []byte) bool

+ func (p *UPSPatch) ValidationInfo() *ValidationInfo

+ type VCDIFFPatch struct

+ func (*VCDIFFPatch) Format() Format

+ func (*VCDIFFPatch) MarshalBinary() ([]byte, error)

+ func (VCDIFFPatch) Description() string

+ func (VCDIFFPatch) ValidateSource([]byte) bool

+ func (VCDIFFPatch) ValidationInfo() *ValidationInfo

+ func (p *VCDIFFPatch) Apply(source []byte, options ApplyOptions) ([]byte, error)

+ type ValidationInfo struct

+ Type string

+ Values []string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL