Merge branch 'master' of github.com:src-d/go-billy
tree: d959f2047bdb2dc5a167b990897f99b1a7989249
  1. memfs/
  2. osfs/
  3. subdir/
  4. test/
  5. .travis.yml
  6. fs.go
  7. LICENSE
  8. Makefile
  9. README.md
  10. utils.go
README.md

go-billy GoDoc Build Status codebeat badge

An interface to abstract several storages.

This library was extracted from src-d/go-git.

Installation

go get -u gopkg.in/src-d/go-billy.v2/...

Why billy?

The library billy deals with storage systems and Billy is the name of a well-known, IKEA bookcase. That's it.

Usage

Billy exposes filesystems using the Filesystem interface. Each filesystem implementation gives you a New method, whose arguments depend on the implementation itself, that returns a new Filesystem.

The following example caches in memory all readable files in a directory from any billy's filesystem implementation.

func LoadToMemory(fs billy.Filesystem, path string) (*memory.Memory, error) {
	memory := memory.New()

	files, err := fs.ReadDir("/")
	if err != nil {
		return nil, err
	}

	for _, file := range files {
		if !file.IsDir() {
			orig, err := fs.Open(file.Name())
			if err != nil {
				continue
			}

			dest, err := memory.Create(file.Name())
			if err != nil {
				continue
			}

			if _, err = io.Copy(dest, orig); err != nil {
				return nil, err
			}
		}
	}

	return memory, nil
}

License

MIT, see LICENSE