tarfs

README

tarfs

Go package bridging between tarballs and fs.FS file systems

Documentation

Index

• Variables
• func Archive(tarball *tar.Writer, fsys fs.FS) error
• func Extract(path string, tarball *tar.Reader) error
• func OpenFS(data io.ReaderAt, size int64) (fs.FS, error)

Variables

var (
	ErrLoop = errors.New("tarfs: loop detected while following symbolic links")
)

Functions

func Archive

func Archive(tarball *tar.Writer, fsys fs.FS) error

Archive archives a file system into a tarball.

If the file system contains symbolic links, it must implement a ReadLink method with this signature to allow reading the value of the link targets:

type ReadLinkFS interface {
	ReadLink(name string) (string, error)
}

See https://github.com/golang/go/issues/49580 for details about the expected behavior of the ReadLinkFS interface.

func Extract

func Extract(path string, tarball *tar.Reader) error

Extract extracts files from the tarbal to a directory at path on the file system.

Note: at this time, since fs.FS is a read-only API, we chose to only support extracting files to a local path. This could be revisited in the future if Go gets an API to interact with writable file systems, likely we would then add a ExtractFS function to maintain backward compatiblity.

func OpenFS

func OpenFS(data io.ReaderAt, size int64) (fs.FS, error)