fs

Documentation

Index

• type Entry
• type EntryKind
• type FS
  • func MockFS(input map[string]string) FS
  • func RealFS() FS

Types

type Entry

type Entry struct {
	Kind    EntryKind
	Symlink string
}

type EntryKind

type EntryKind uint8

const (
	DirEntry  EntryKind = 1
	FileEntry EntryKind = 2
)

type FS

type FS interface {
	// The returned map is immutable and is cached across invocations. Do not
	// mutate it.
	ReadDirectory(path string) map[string]Entry
	ReadFile(path string) (string, bool)

	// This is part of the interface because the mock interface used for tests
	// should not depend on file system behavior (i.e. different slashes for
	// Windows) while the real interface should.
	Abs(path string) (string, bool)
	Dir(path string) string
	Base(path string) string
	Ext(path string) string
	Join(parts ...string) string
	RelativeToCwd(path string) (string, bool)
}

func MockFS

func MockFS(input map[string]string) FS

func RealFS

func RealFS() FS