archiverext

Documentation

Index

• type FileFS
  • func (f FileFS) Open(name string) (fs.File, error)
  • func (f FileFS) ReadDir(name string) ([]fs.DirEntry, error)
  • func (f FileFS) Stat(name string) (fs.FileInfo, error)

Types

type FileFS

type FileFS struct {
	// File is the compressed file backing the FileFS.
	File fs.File

	// If file is compressed, setting this field will
	// transparently decompress reads.
	Compression archiver.Decompressor
}

FileFS allows accessing a file on disk using a consistent file system interface. The value should be the path to a regular file, not a directory. This file will be the only entry in the file system and will be at its root. It can be accessed within the file system by the name of "." or the filename.

If the file is compressed, set the Compression field so that reads from the file will be transparently decompressed.

func (FileFS) Open

func (f FileFS) Open(name string) (fs.File, error)

Open opens the named file, which must be the file used to create the file system.

func (FileFS) ReadDir

func (f FileFS) ReadDir(name string) ([]fs.DirEntry, error)

ReadDir returns a directory listing with the file as the singular entry.

func (FileFS) Stat

func (f FileFS) Stat(name string) (fs.FileInfo, error)

Stat stats the named file, which must be the file used to create the file system.