aferox

README

aferox

The aferox packages expands on github.com/spf13/afero by adding more afero.Fs implementations as well as various afero.Fs utility functions.

context

The context package adds the context.Fs interface for filesystem implementations that accept a context.Context per operation. It has a basic test suite and generally works but should be considered a 🚧 work in progress 🚧.

The context package re-exports various functions and types from the standard context packge for convenience. Currently the creation functions focus on adapting external context.Fs implementations to an afero.Fs to be used with the other utility functions.

var base context.Fs = mypkg.NewEffectfulFs()

fs := context.BackgroundFs(base)

var accessor context.AccessorFunc = func() context.Context {
	return context.Background()
}

// Equivalent to `context.BackgroundFs`
fs := context.NewFs(base, accessor)

The context.AferoFs interface is a union of afero.Fs and context.Fs, i.e. exposing both fs.Create and fs.CreateContext. I'm not sure if this actually has any value but it exists.

The context.Discard function adapts an afero.Fs to a context.AferoFs by ignoring the context.Context argument.

base := afero.NewMemMapFs()

var fs context.AferoFs = context.Discard(base)

docker

The docker package adds a docker afero.Fs implementation for operating on the filesystem of a container.

client := client.NewClientWithOpts(client.FromEnv)

fs := docker.NewFs(client, "my-container-id")

filter

The filter package adds a filtering implementation of afero.Fs similar to afero.RegExpFs at accepts a predicate instead.

base := afero.NewMemMapFs()

fs := filter.NewFs(base, func(path string) bool {
	return filepath.Ext(path) == ".go"
})

github

The github package adds multiple implementations of afero.Fs for interacting with the GitHub API as if it were a filesystem. In general it can turn a GitHub url into an afero.Fs.

fs := github.NewFs(github.NewClient(nil))

file, _ := fs.Open("https://github.com/unmango")

// ["go", "thecluster", "pulumi-baremetal", ...]
file.Readdirnames(420)

ignore

The ignore package adds a filtering afero.Fs that accepts a .gitignore file and ignores paths matched by it.

base := afero.NewMemMapFs()

gitignore, _ := os.Open("path/to/my/.gitignore")

fs, _ := ignore.NewFsFromGitIgnoreReader(base, gitignore)

testing

The testing package adds helper stubs for mocking filesystems in tests.

fs := &testing.Fs{
	CreateFunc: func(name string) (afero.File, error) {
		return nil, errors.New("simulated error")
	}
}

writer

The writer package adds a readonly afero.Fs implementation that dumps all file writes to the provided io.Writer. Currently paths are ignored and there are no delimeters separating files.

buf := &bytes.Buffer{}
fs := writer.NewFs(buf)

_ = afero.WriteFile(fs, "test.txt", []byte("testing"), os.ModePerm)
_ = afero.WriteFile(fs, "other.txt", []byte("blah"), os.ModePerm)

// "testingblah"
buf.String()

Documentation

Index

• func ContinueOnError(options *iterOptions)
• func Copy(src, dest afero.Fs) error
• func Fold[T any](fsys afero.Fs, root string, folder FoldFunc[T], initial T) (acc T, err error)
• func FromContext(ctx context.Context) afero.Fs
• func Iter(fsys afero.Fs, root string, options ...IterOption) iter.Seq3[string, fs.FileInfo, error]
• func NewWriter(w io.Writer) afero.Fs
• func OpenFirst(fsys afero.Fs, root string, options ...IterOption) (afero.File, error)
• func OpenSingle(fsys afero.Fs, root string, options ...IterOption) (afero.File, error)
• func SetContext(fs afero.Fs, ctx context.Context) error
• func SkipDirs(options *iterOptions)
• func StatFirst(fsys afero.Fs, root string, options ...IterOption) (fs.FileInfo, error)
• func StatSingle(fsys afero.Fs, root string, options ...IterOption) (fs.FileInfo, error)
• type ErrFilter
• type FoldFunc
• type IterOption
  • func FilterErrors(filter ErrFilter) IterOption
• type Writer

Functions

func ContinueOnError

func ContinueOnError(options *iterOptions)

func Copy

func Copy(src, dest afero.Fs) error

func Fold

func Fold[T any](fsys afero.Fs, root string, folder FoldFunc[T], initial T) (acc T, err error)

func FromContext

func FromContext(ctx context.Context) afero.Fs

func Iter

func Iter(fsys afero.Fs, root string, options ...IterOption) iter.Seq3[string, fs.FileInfo, error]

func NewWriter

func NewWriter(w io.Writer) afero.Fs

func OpenFirst

func OpenFirst(fsys afero.Fs, root string, options ...IterOption) (afero.File, error)

func OpenSingle

func OpenSingle(fsys afero.Fs, root string, options ...IterOption) (afero.File, error)

func SetContext

func SetContext(fs afero.Fs, ctx context.Context) error

func SkipDirs

func SkipDirs(options *iterOptions)

func StatFirst

func StatFirst(fsys afero.Fs, root string, options ...IterOption) (fs.FileInfo, error)

func StatSingle

func StatSingle(fsys afero.Fs, root string, options ...IterOption) (fs.FileInfo, error)

Types

type ErrFilter

type ErrFilter func(error) error

type FoldFunc

type FoldFunc[T any] func(string, fs.FileInfo, T, error) (T, error)

type IterOption

type IterOption func(*iterOptions)

func FilterErrors

func FilterErrors(filter ErrFilter) IterOption

type Writer

type Writer = writer.Fs