catalog

Documentation

Index

• Constants
• func WriteFile(name string, catalog *Catalog) error
• type Catalog
  • func New(files map[string][]string) *Catalog
  • func ReadFile(name string) (*Catalog, error)
  • func ReadFrom(r io.Reader) (*Catalog, error)
  • func (catalog *Catalog) Search(path string) (*Record, bool)
  • func (catalog *Catalog) WriteTo(w io.Writer) (n int64, err error)
• type Record
  • func (record *Record) TreeIndices() *binarytree.Indices
• type RecordError
  • func (err *RecordError) Error() string
  • func (err *RecordError) Unwrap() error

Constants

const (
	CatalogVersion = 3
)

Functions

func WriteFile

func WriteFile(name string, catalog *Catalog) error

Writes the contents of the *Catalog to the file specified by path.

Types

type Catalog

type Catalog struct {
	Version int32

	PackNames []string
	Records   []*Record
}

func New

func New(files map[string][]string) *Catalog

Creates a new catalog from a map of pack names to a list of file names.

func ReadFile

func ReadFile(name string) (*Catalog, error)

Creates a *Catalog out of the *os.File from the given path.

func ReadFrom

func ReadFrom(r io.Reader) (*Catalog, error)

Creates a *Catalog from the contents of the given io.Reader.

func (*Catalog) Search

func (catalog *Catalog) Search(path string) (*Record, bool)

func (*Catalog) WriteTo

func (catalog *Catalog) WriteTo(w io.Writer) (n int64, err error)

type Record

type Record struct {
	PackName string

	Crc uint32
	binarytree.Indices

	IsCompressed bool
}

func (*Record) TreeIndices

func (record *Record) TreeIndices() *binarytree.Indices

type RecordError

type RecordError struct {
	Err   error
	Field string
}

func (*RecordError) Error

func (err *RecordError) Error() string

func (*RecordError) Unwrap

func (err *RecordError) Unwrap() error