gcsfs

README

github.com/jarxorg/gcsfs

Package gcsfs provides an implementation of wfs for GCS (Google Cloud Storage).

Examples

ReadDir

package main

import (
  "fmt"
  "io/fs"
  "log"

  "github.com/jarxorg/gcsfs"
)

func main() {
  fsys := gcsfs.New("<your-bucket>")
  entries, err := fs.ReadDir(fsys, ".")
  if err != nil {
    log.Fatal(err)
  }
  for _, entry := range entries {
    fmt.Println(entry.Name())
  }
}

WriteFile

package main

import (
  "io/fs"
  "log"

  "github.com/jarxorg/wfs"
  "github.com/jarxorg/gcsfs"
)

func main() {
  fsys := gcsfs.New("<your-bucket>")
  _, err := wfs.WriteFile(fsys, "test.txt", []byte(`Hello`), fs.ModePerm)
  if err != nil {
    log.Fatal(err)
  }
}

Tests

GCSFS can pass TestFS in "testing/fstest".

import (
  "testing/fstest"

  "github.com/jarxorg/gcsfs"
)

// ...

fsys := gcsfs.New("<your-bucket>")
if err := fstest.TestFS(fsys, "<your-expected>"); err != nil {
  t.Errorf("Error testing/fstest: %+v", err)
}

Integration tests

FSTEST_BUCKET="<your-bucket>" \
FSTEST_EXPECTED="<your-expected>" \
  go test -tags integtest ./...

Documentation

Index

• type GCSFS
  • func New(bucket string) *GCSFS
  • func NewWithClient(bucket string, client *storage.Client) *GCSFS
  • func (fsys *GCSFS) Close() error
  • func (fsys *GCSFS) Context() context.Context
  • func (fsys *GCSFS) CreateFile(name string, mode fs.FileMode) (wfs.WriterFile, error)
  • func (fsys *GCSFS) Glob(pattern string) ([]string, error)
  • func (fsys *GCSFS) MkdirAll(dir string, mode fs.FileMode) error
  • func (fsys *GCSFS) Open(name string) (fs.File, error)
  • func (fsys *GCSFS) ReadDir(dir string) ([]fs.DirEntry, error)
  • func (fsys *GCSFS) ReadFile(name string) ([]byte, error)
  • func (fsys *GCSFS) RemoveAll(dir string) error
  • func (fsys *GCSFS) RemoveFile(name string) error
  • func (fsys *GCSFS) Stat(name string) (fs.FileInfo, error)
  • func (fsys *GCSFS) Sub(dir string) (fs.FS, error)
  • func (fsys *GCSFS) WithClient(client *storage.Client) *GCSFS
  • func (fsys *GCSFS) WithContext(ctx context.Context) *GCSFS
  • func (fsys *GCSFS) WriteFile(name string, p []byte, mode fs.FileMode) (int, error)

Types

type GCSFS

type GCSFS struct {
	// DirOpenBufferSize is the buffer size for using objects as the directory. (Default 100)
	DirOpenBufferSize int
	// contains filtered or unexported fields
}

GCSFS represents a filesystem on GCS (Google Cloud Storage).

func New

func New(bucket string) *GCSFS

New returns a filesystem for the tree of objects rooted at the specified bucket.

func NewWithClient

func NewWithClient(bucket string, client *storage.Client) *GCSFS

NewWithClient returns a filesystem for the tree of objects rooted at the specified bucket with *storage.Client. The specified client will be closed by Close.

ctx := context.Background()
client, err := storage.NewClient(ctx)
if err != nil {
  log.Fatal(err)
}
fsys := gcsfs.NewWithClient("<your-bucket>", client).WithContext(ctx)
defer fsys.Close() // Close closes the specified client.

func (*GCSFS) Close

func (fsys *GCSFS) Close() error

Close closes holded storage client.

func (*GCSFS) Context

func (fsys *GCSFS) Context() context.Context

Context returns a holded context. If this filesystem has no context then context.Background() will use.

func (*GCSFS) CreateFile

func (fsys *GCSFS) CreateFile(name string, mode fs.FileMode) (wfs.WriterFile, error)

CreateFile creates the named file. The specified mode is ignored.

func (*GCSFS) Glob

func (fsys *GCSFS) Glob(pattern string) ([]string, error)

Glob returns the names of all files matching pattern, providing an implementation of the top-level Glob function.

func (*GCSFS) MkdirAll

func (fsys *GCSFS) MkdirAll(dir string, mode fs.FileMode) error

MkdirAll always do nothing.

func (*GCSFS) Open

func (fsys *GCSFS) Open(name string) (fs.File, error)

Open opens the named file or directory.

func (*GCSFS) ReadDir

func (fsys *GCSFS) ReadDir(dir string) ([]fs.DirEntry, error)

ReadDir reads the named directory and returns a list of directory entries sorted by filename.

func (*GCSFS) ReadFile

func (fsys *GCSFS) ReadFile(name string) ([]byte, error)

ReadFile reads the named file and returns its contents.

func (*GCSFS) RemoveAll

func (fsys *GCSFS) RemoveAll(dir string) error

RemoveAll removes path and any children it contains.

func (*GCSFS) RemoveFile

func (fsys *GCSFS) RemoveFile(name string) error

RemoveFile removes the specified named file.

func (*GCSFS) Stat

func (fsys *GCSFS) Stat(name string) (fs.FileInfo, error)

Stat returns a FileInfo describing the file. If there is an error, it should be of type *PathError.

func (*GCSFS) Sub

func (fsys *GCSFS) Sub(dir string) (fs.FS, error)

Sub returns an FS corresponding to the subtree rooted at dir.

func (*GCSFS) WithClient

func (fsys *GCSFS) WithClient(client *storage.Client) *GCSFS

WithClient holds the specified client. The specified client is closed by Close.

func (*GCSFS) WithContext

func (fsys *GCSFS) WithContext(ctx context.Context) *GCSFS

WithContext holds the specified context.

func (*GCSFS) WriteFile

func (fsys *GCSFS) WriteFile(name string, p []byte, mode fs.FileMode) (int, error)

WriteFile writes the specified bytes to the named file. The specified mode is ignored.