README
¶
go-vfsbilly
Package vfsbilly provides a compatibility later between
github.com/twpayne/go-vfs and
github.com/src-d/go-billy.
This allows you to use vfst to test exisiting code that uses
billy.Filesystem.
See the documentation for
an example.
License
The MIT License (MIT)
Copyright (c) 2018 Tom Payne
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Documentation
¶
Overview ¶
Package vfsbilly provides a compatibility layer between github.com/twpayne/go-vfs and github.com/src-d/go-billy.
Index ¶
- type BillyFS
- func (b *BillyFS) Capabilities() billy.Capability
- func (b *BillyFS) Chroot(path string) (billy.Filesystem, error)
- func (b *BillyFS) Create(filename string) (billy.File, error)
- func (b *BillyFS) Join(elem ...string) string
- func (b *BillyFS) MkdirAll(filename string, perm os.FileMode) error
- func (b *BillyFS) Open(filename string) (billy.File, error)
- func (b *BillyFS) OpenFile(filename string, flag int, perm os.FileMode) (billy.File, error)
- func (b *BillyFS) Root() string
- func (b *BillyFS) TempFile(dir, prefix string) (billy.File, error)
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BillyFS ¶
A BillyFS implements github.com/src-d/go-billy.Filesystem.
func NewBillyFS ¶
NewBillyFS returns a new BillyFS.
Example ¶
package main
import (
"testing"
vfsbilly "github.com/danielmmetz/go-vfsbilly"
"github.com/twpayne/go-vfs/vfst"
billyutil "gopkg.in/src-d/go-billy.v4/util"
)
func main() {
Test := func(t *testing.T) {
fs, cleanup, err := vfst.NewTestFS(map[string]interface{}{
"/home/user/.bashrc": "# contents of .bashrc\n",
})
if err != nil {
t.Fatal(err)
}
defer cleanup()
billyFS := vfsbilly.NewBillyFS(fs)
if err := billyutil.WriteFile(billyFS, "/home/user/foo", []byte("bar"), 0666); err != nil {
t.Errorf("billyutil.WriteFile(...) == %v, want <nil>", err)
}
vfst.RunTests(t, fs, "",
vfst.TestPath("/home/user/foo",
vfst.TestContentsString("bar"),
),
)
}
Test(&testing.T{})
}
Output:
func (*BillyFS) Capabilities ¶
func (b *BillyFS) Capabilities() billy.Capability
Capabilities implements billy.Filesystem.Capabilities.
func (*BillyFS) Chroot ¶
func (b *BillyFS) Chroot(path string) (billy.Filesystem, error)
Chroot implements billy.Chroot.Chroot.
Source Files