memfis

Documentation

Index

• type File
• type FileSizer
• type MemFS
  • func MakeMemFS(files ...File) (MemFS, error)

Types

type File

type File interface {
	// GetName returns the root-relative file path.
	// The path must use "/" as directory separator.
	// It must not use escaping or "." and ".." segements.
	// The characters "/" and "\" are forbidden in path segments.
	GetName() string
	// GetContent returns the data contained in the file.
	GetContent() string
}

File is a minimal representation of a file that is read only and provides only its name and contents. It is a bad fit for large files as its only way to access file contents is retrieving all of it as a string.

type FileSizer

type FileSizer interface {
	File
	// Size retrieves the file size in bytes; it must match len(GetContent())
	Size() int64
}

FileSizer is a file that supports direct retrieval of the file size.

type MemFS

type MemFS interface {
	fs.GlobFS
	fs.ReadDirFS
	fs.ReadFileFS
	fs.StatFS
	fs.SubFS
}

func MakeMemFS

func MakeMemFS(files ...File) (MemFS, error)