Documentation
¶
Overview ¶
Google Cloud Storage VFS implementation.
See: https://github.com/GoogleCloudPlatform/google-cloud-go.
Index ¶
- Constants
- type File
- func (f *File) Close() (rerr error)
- func (f *File) CopyToFile(targetFile vfs.File) error
- func (f *File) CopyToLocation(location vfs.Location) (vfs.File, error)
- func (f *File) Delete() error
- func (f *File) Exists() (bool, error)
- func (f *File) LastModified() (*time.Time, error)
- func (f *File) Location() vfs.Location
- func (f *File) MoveToFile(targetFile vfs.File) error
- func (f *File) MoveToLocation(location vfs.Location) (vfs.File, error)
- func (f *File) Name() string
- func (f *File) Path() string
- func (f *File) Read(p []byte) (n int, err error)
- func (f *File) Seek(offset int64, whence int) (int64, error)
- func (f *File) Size() (uint64, error)
- func (f *File) String() string
- func (f *File) URI() string
- func (f *File) Write(data []byte) (n int, err error)
- type FileSystem
- type Location
- func (l *Location) ChangeDir(relativePath string) error
- func (l *Location) DeleteFile(fileName string) error
- func (l *Location) Exists() (bool, error)
- func (l *Location) FileSystem() vfs.FileSystem
- func (l *Location) List() ([]string, error)
- func (l *Location) ListByPrefix(filenamePrefix string) ([]string, error)
- func (l *Location) ListByRegex(regex *regexp.Regexp) ([]string, error)
- func (l *Location) NewFile(filePath string) (vfs.File, error)
- func (l *Location) NewLocation(relativePath string) (vfs.Location, error)
- func (l *Location) Path() string
- func (l *Location) String() string
- func (l *Location) URI() string
- func (l *Location) Volume() string
Constants ¶
const Scheme = "gs"
Scheme defines the filesystem type.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type File ¶
type File struct {
// contains filtered or unexported fields
}
func (*File) Close ¶
Close cleans up underlying mechanisms for reading from and writing to the file. Closes and removes the local temp file, and triggers a write to GCS of anything in the f.writeBuffer if it has been created.
func (*File) CopyToFile ¶
CopyToFile puts the contents of File into the targetFile passed. Uses the GCS CopierFrom method if the target file is also on GCS, otherwise uses io.Copy.
func (*File) CopyToLocation ¶
CopyToLocation creates a copy of *File, using the file's current name as the new file's name at the given location. If the given location is also GCS, the GCS API for copying files will be utilized, otherwise, standard io.Copy will be done to the new file.
func (*File) Delete ¶
Delete clears any local temp file, or write buffer from read/writes to the file, then makes a DeleteObject call to s3 for the file. Returns any error returned by the API.
func (*File) LastModified ¶
LastModified returns the 'Updated' property from the GCS attributes.
func (*File) Location ¶
Location returns a Location instance for the file's current location.
TODO should this be including trailing slash?
func (*File) MoveToFile ¶
MoveToFile puts the contents of File into the targetFile passed using File.CopyToFile. If the copy succeeds, the source file is deleted. Any errors from the copy or delete are returned.
func (*File) MoveToLocation ¶
MoveToLocation works by first calling File.CopyToLocation(vfs.Location) then, if that succeeds, it deletes the original file, returning the new file. If the copy process fails the error is returned, and the Delete isn't called. If the call to Delete fails, the error and the file generated by the copy are both returned.
func (*File) Read ¶
Read implements the standard for io.Reader. For this to work with an GCS file, a temporary local copy of the file is created, and reads work on that. This file is closed and removed upon calling f.Close()
func (*File) Seek ¶
Seek implements the standard for io.Seeker. A temporary local copy of the GCS file is created (the same one used for Reads) which Seek() acts on. This file is closed and removed upon calling f.Close()
type FileSystem ¶
type FileSystem struct {
// contains filtered or unexported fields
}
FileSystem implements vfs.Filesystem for the GCS filesystem.
func NewFileSystem ¶
func NewFileSystem(ctx context.Context, client *storage.Client) *FileSystem
NewFileSystem intializer for FileSystem struct accepts google cloud storage client and returns Filesystem or error.
func (*FileSystem) NewLocation ¶
NewLocation function returns the s3 implementation of vfs.Location.
func (*FileSystem) Scheme ¶
func (fs *FileSystem) Scheme() string
Scheme return "gs" as the initial part of a file URI ie: gs://
type Location ¶
type Location struct {
// contains filtered or unexported fields
}
Implements vfs.Location
func (*Location) ChangeDir ¶
ChangeDir changes the current location's path to the new, relative path.
func (*Location) DeleteFile ¶
DeleteFile deletes the file at the given path, relative to the current location.
func (*Location) Exists ¶
Exists returns whether the location exists or not. In the case of an error, false is returned.
func (*Location) FileSystem ¶
func (l *Location) FileSystem() vfs.FileSystem
FileSystem returns the GCS file system instance.
func (*Location) ListByPrefix ¶
ListByPrefix returns a slice of file base names and any error, if any prefix means filename prefix and therefore should not have slash List functions return only files List functions return only basenames
func (*Location) ListByRegex ¶
ListByPrefix returns a list of file names at the location which match the provided regular expression.
func (*Location) NewFile ¶
NewFile returns a new file instance at the given path, relative to the current location.
func (*Location) NewLocation ¶
NewLocation creates a new location instance relative to the current location's path.
func (*Location) Path ¶
Path returns the path of the file at the current location, starting with a leading '/'
Source Files