re
/
afero
forked from mirror/afero
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update examples to use 'afero.' before calls

This commit is contained in:
Steve Francia 2016-01-11 21:49:09 -05:00
parent cb3771c13a
commit 52ef806ebb
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -223,7 +223,7 @@ calls. It also makes it trivial to have your code use the OS during
operation and a mock filesystem during testing or as needed. operation and a mock filesystem during testing or as needed.
```go ```go
appfs := NewOsFs() appfs := afero.NewOsFs()
appfs.MkdirAll("src/a", 0755)) appfs.MkdirAll("src/a", 0755))
``` ```
@ -237,7 +237,7 @@ necessary. It is fully concurrent and will work within go routines
safely. safely.
```go ```go
mm := NewMemMapFs() mm := afero.NewMemMapFs()
mm.MkdirAll("src/a", 0755)) mm.MkdirAll("src/a", 0755))
``` ```
@ -264,7 +264,7 @@ The given file name to the operations on this Fs will be prepended with
the base path before calling the source Fs. the base path before calling the source Fs.
```go ```go
bp := NewBasePathFs(NewOsFs(), "/base/path") bp := afero.NewBasePathFs(afero.NewOsFs(), "/base/path")
``` ```
### ReadOnlyFs ### ReadOnlyFs
@ -272,7 +272,7 @@ bp := NewBasePathFs(NewOsFs(), "/base/path")
A thin wrapper around the source Fs providing a read only view. A thin wrapper around the source Fs providing a read only view.
```go ```go
fs := NewReadOnlyFs(NewOsFs()) fs := afero.NewReadOnlyFs(afero.NewOsFs())
_, err := fs.Create("/file.txt") _, err := fs.Create("/file.txt")
// err = syscall.EPERM // err = syscall.EPERM
``` ```
@ -285,7 +285,7 @@ Files not matching the regexp provided will not be created.
Directories are not filtered. Directories are not filtered.
```go ```go
fs := NewRegexpFs(NewMemMapFs(), regexp.MustCompile(`\.txt$`)) fs := afero.NewRegexpFs(afero.NewMemMapFs(), regexp.MustCompile(`\.txt$`))
_, err := fs.Create("/file.html") _, err := fs.Create("/file.html")
// err = syscall.ENOENT // err = syscall.ENOENT
``` ```
@ -334,9 +334,9 @@ from the base to the overlay when they're not present (or outdated) in the
caching layer. caching layer.
```go ```go
base := NewOsFs() base := afero.NewOsFs()
layer := NewMemMapFs() layer := afero.NewMemMapFs()
ufs := NewCacheOnReadFs(base, layer, 100 * time.Second) ufs := afero.NewCacheOnReadFs(base, layer, 100 * time.Second)
``` ```
### CopyOnWriteFs() ### CopyOnWriteFs()
@ -360,9 +360,9 @@ overlay will be removed/renamed.
The writable overlay layer is currently limited to MemMapFs. The writable overlay layer is currently limited to MemMapFs.
```go ```go
base := NewOsFs() base := afero.NewOsFs()
roBase := NewReadOnlyFs(base) roBase := afero.NewReadOnlyFs(base)
ufs := NewCopyOnWriteFs(roBase, NewMemMapFs()) ufs := afero.NewCopyOnWriteFs(roBase, afero.NewMemMapFs())
fh, _ = ufs.Create("/home/test/file2.txt") fh, _ = ufs.Create("/home/test/file2.txt")
fh.WriteString("This is a test") fh.WriteString("This is a test")