archive

Documentation

Index

• Variables
• func RegisterFormat(name string, read func(string) ([]FileData, error), match func(string) bool)
• type FileData
  • func Read(name string) ([]FileData, string, error)

Variables

var ErrFormat = errors.New("archive: unknown format")

ErrFormat is the error returned when archive is asked to get the files from an unkown archive format.

Functions

func RegisterFormat

func RegisterFormat(name string, read func(string) ([]FileData, error), match func(string) bool)

RegisterFormat registers an archive format by mapping its name to a read function and a function that checks if a file is of a specific archive type. It is typically called from an init function in the archive package registering itself.

Types

type FileData

type FileData struct {
	Name string
	Size uint64
}

FileData describes a file in an archive by name and size (uncompressed).

func Read

func Read(name string) ([]FileData, string, error)

Read returns a slice of file data structs for the archive in name and the type of archive, or ErrFormat if the archive type isn't registered.