This repository has been archived on 2024-01-11. You can view files and clone it, but cannot push or open issues or pull requests.
gitea/vendor/github.com/go-git/go-billy/v5
2020-03-17 12:19:58 -04:00
..
helper Migrate to go-git/go-git v5.0.0 (#10735) 2020-03-17 12:19:58 -04:00
osfs Migrate to go-git/go-git v5.0.0 (#10735) 2020-03-17 12:19:58 -04:00
util Migrate to go-git/go-git v5.0.0 (#10735) 2020-03-17 12:19:58 -04:00
.gitignore Migrate to go-git/go-git v5.0.0 (#10735) 2020-03-17 12:19:58 -04:00
fs.go Migrate to go-git/go-git v5.0.0 (#10735) 2020-03-17 12:19:58 -04:00
go.mod Migrate to go-git/go-git v5.0.0 (#10735) 2020-03-17 12:19:58 -04:00
go.sum Migrate to go-git/go-git v5.0.0 (#10735) 2020-03-17 12:19:58 -04:00
LICENSE Migrate to go-git/go-git v5.0.0 (#10735) 2020-03-17 12:19:58 -04:00
README.md Migrate to go-git/go-git v5.0.0 (#10735) 2020-03-17 12:19:58 -04:00

go-billy GoDoc Test

The missing interface filesystem abstraction for Go. Billy implements an interface based on the os standard library, allowing to develop applications without dependency on the underlying storage. Makes it virtually free to implement mocks and testing over filesystem operations.

Billy was born as part of go-git/go-git project.

Installation

import "github.com/go-git/go-billy/v5" // with go modules enabled (GO111MODULE=on or outside GOPATH)
import "github.com/go-git/go-billy" // with go modules disabled

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(origin billy.Filesystem, path string) (*memory.Memory, error) {
	memory := memory.New()

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

	for _, file := range files {
		if file.IsDir() {
			continue
		}

		src, err := origin.Open(file.Name())
		if err != nil {
			return nil, err
		}

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

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

		if err := dst.Close(); err != nil {
			return nil, err
		}

		if err := src.Close(); err != nil {
			return nil, err
		}
	}

	return memory, nil
}

Why billy?

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

License

Apache License Version 2.0, see LICENSE