metadata

Documentation

Overview

Package metadata implements the small metadata database written to each directory on the MegaSD filesystem that contains ROM and/or CD images.

Index

• Constants
• func CRCFilename(filename string) uint32
• type DB
  • func New() *DB
  • func (db *DB) Length() int
  • func (db *DB) MarshalBinary() ([]byte, error)
  • func (db *DB) Set(crc uint32, screenshot []byte) error
  • func (db *DB) UnmarshalBinary(b []byte) error

Constants

const (
	// Filename is the expected filename used when writing to disk
	Filename = "games.dbs"

	// ScreenshotSize defines the expected size in bytes of each screenshot
	ScreenshotSize = 2048
)

Functions

func CRCFilename

func CRCFilename(filename string) uint32

CRCFilename computes the CRC of a given filename using the same algorithm as implemented in the MegaSD firmware

Types

type DB

type DB struct {
	// contains filtered or unexported fields
}

DB is the metadata database object. It implements the encoding.BinaryMarshaler and encoding.BinaryUnmarshaler interfaces.

func New

func New() *DB

New returns an empty metadata database

func (*DB) Length

func (db *DB) Length() int

Length returns the number of checksums in the database

func (*DB) MarshalBinary

func (db *DB) MarshalBinary() ([]byte, error)

MarshalBinary encodes the database into binary form and returns the result

func (*DB) Set

func (db *DB) Set(crc uint32, screenshot []byte) error

Set stores the provided screenshot for the given CRC

func (*DB) UnmarshalBinary

func (db *DB) UnmarshalBinary(b []byte) error

UnmarshalBinary decodes the database from binary form