Categorygithub.com/bodgit/rom
modulepackage
0.0.1
Repository: https://github.com/bodgit/rom.git
Documentation: pkg.go.dev

# README

GitHub release Build Status Coverage Status Go Report Card GoDoc Go version Go version

rom

# Packages

No description provided by the author
Package dat implements parsing of XML dat files as commonly used by ROM/Disc preservation projects such as http://redump.org and https://no-intro.org.
Package synchronizer implements a set of methods to maintain a pristine directory of TorrentZip files representing the games in a dat file.

# Functions

NewDirectoryReader returns a new DirectoryReader for the passed directory.
NewDirectoryWriter returns a new DirectoryWriter for the passed directory.
NewFileReader returns a new FileReader for the passed filename.
NewFileWriter returns a new FileWriter for the passed filename.
NewRarReader returns a new RarReader for the passed filename.
NewReader uses heuristics to work out the type of file passed and uses the most appropriate Reader to access it.
NewSevenZipReader returns a new SevenZipReader for the passed 7zip archive.
NewTorrentZipReader returns a new TorrentZipReader for the passed zip archive.
NewTorrentZipWriter returns a new TorrentZipWriter for the passed zip archive.
NewZipReader returns a new ZipReader for the passed zip archive.
NewZipWriter returns a new ZipWriter for the passed zip archive.

# Constants

Supported checksum/hash types.
Supported checksum/hash types.
Supported checksum/hash types.

# Variables

ErrNotTorrentZip is returned if a zip file does not have the correct archive comment.

# Structs

DirectoryReader reads a directory and provides access to any regular files contained within.
DirectoryWriter creates a directory if necessary and then writes new files inside it.
FileReader reads a single regular file and coerces it into looking like an archive containing exactly one file.
FileWriter writes a single regular file as if it was an archive containing exactly one file.
RarReader reads a RAR archive and provides access to any regular files contained within.
SevenZipReader reads a 7zip archive and provides access to any regular files contained within.
TorrentZipReader reads a zip archive and provides access to any regular files contained within.
TorrentZipWriter creates a new zip archive using the torrentzip standard.
ZipReader reads a zip archive and provides access to any regular files contained within.
ZipWriter creates a new zip archive.

# Interfaces

Reader is the interface implemented by all ROM readers.
Validator is the interface optionally implemented by a ROM reader if it can validate its integrity somehow.
Writer is the interface implemented by all ROM writers.

# Type aliases

Checksum is used to specify a checksum/hash type.