README
¶
s3fs
Package s3fs provides a S3 implementation for Afero
s3fs uses prefixpath to implement buckets
the implementation wraps aws sdk go s3 client.
it is based off of https://github.com/jszwec/s3fs
Installation
go get gfx.cafe/open/s3fs
Requirements
- Go1.16+
Documentation
¶
Index ¶
- Constants
- Variables
- type File
- func (f *File) Close() error
- func (f *File) Name() string
- func (r *File) RangeReader(from, amt int64) (io.ReadCloser, error)
- func (f *File) Read(p []byte) (int, error)
- func (f *File) ReadAt(p []byte, off int64) (n int, err error)
- func (f *File) Readdir(n int) ([]os.FileInfo, error)
- func (f *File) ReaddirAll() ([]os.FileInfo, error)
- func (f *File) Readdirnames(n int) ([]string, error)
- func (f *File) Seek(offset int64, whence int) (int64, error)
- func (f *File) Stat() (os.FileInfo, error)
- func (f *File) Sync() error
- func (f *File) Truncate(int64) error
- func (f *File) Write(p []byte) (int, error)
- func (f *File) WriteAt(p []byte, off int64) (n int, err error)
- func (f *File) WriteString(s string) (int, error)
- type FileInfo
- type Fs
- func (fs Fs) Chmod(name string, mode os.FileMode) error
- func (Fs) Chown(string, int, int) error
- func (Fs) Chtimes(string, time.Time, time.Time) error
- func (fs Fs) Create(name string) (afero.File, error)
- func (fs Fs) Mkdir(name string, perm os.FileMode) error
- func (fs Fs) MkdirAll(path string, perm os.FileMode) error
- func (Fs) Name() string
- func (fs *Fs) Open(name string) (afero.File, error)
- func (fs *Fs) OpenFile(name string, flag int, _ os.FileMode) (afero.File, error)
- func (fs Fs) Remove(name string) error
- func (fs *Fs) RemoveAll(name string) error
- func (fs Fs) Rename(oldname, newname string) error
- func (fs Fs) Stat(name string) (os.FileInfo, error)
- type GetOptions
- type UploadedFileProperties
Constants ¶
const READAHEAD = 16 * 1024 * 1024 // 16mb readahead
const WRITEBUFFER = 8 * 1024 * 1024 // 8mb part size for upload
Variables ¶
var ErrAlreadyOpened = errors.New("already opened")
ErrAlreadyOpened is returned when the file is already opened
var ErrInvalidSeek = errors.New("invalid seek offset")
ErrInvalidSeek is returned when the seek operation is not doable
var ErrNotImplemented = errors.New("not implemented")
ErrNotImplemented is returned when this operation is not (yet) implemented
var ErrNotSupported = errors.New("s3 doesn't support this operation")
ErrNotSupported is returned when this operations is not supported by S3
Functions ¶
This section is empty.
Types ¶
type File ¶ added in v0.5.2
type File struct {
os.FileInfo // File info cached for later used
// contains filtered or unexported fields
}
File represents a file in S3. nolint: govet
func (*File) Close ¶ added in v0.5.2
Close closes the File, rendering it unusable for I/O. It returns an error, if any.
func (*File) Name ¶ added in v0.5.2
Name returns the filename, i.e. S3 path without the bucket name.
func (*File) RangeReader ¶ added in v0.5.2
func (r *File) RangeReader(from, amt int64) (io.ReadCloser, error)
RangeReader produces an io.ReadCloser that reads bytes in the range from [off, off+width)
It is the caller's responsibility to call Close() on the returned io.ReadCloser.
func (*File) Read ¶ added in v0.5.2
Read reads up to len(b) bytes from the File. It returns the number of bytes read and an error, if any. EOF is signaled by a zero count with err set to io.EOF.
func (*File) ReadAt ¶ added in v0.5.2
ReadAt reads len(p) bytes from the file starting at byte offset off. It returns the number of bytes read and the error, if any. ReadAt always returns a non-nil error when n < len(b). At end of file, that error is io.EOF.
func (*File) Readdir ¶ added in v0.5.2
Readdir reads the contents of the directory associated with file and returns a slice of up to n FileInfo values, as would be returned by ListObjects, in directory order. Subsequent calls on the same file will yield further FileInfos.
If n > 0, Readdir returns at most n FileInfo structures. In this case, if Readdir returns an empty slice, it will return a non-nil error explaining why. At the end of a directory, the error is io.EOF.
If n <= 0, Readdir returns all the FileInfo from the directory in a single slice. In this case, if Readdir succeeds (reads all the way to the end of the directory), it returns the slice and a nil error. If it encounters an error before the end of the directory, Readdir returns the FileInfo read until that point and a non-nil error.
func (*File) ReaddirAll ¶ added in v0.5.2
ReaddirAll provides list of file cachedInfo.
func (*File) Readdirnames ¶ added in v0.5.2
Readdirnames reads and returns a slice of names from the directory f.
If n > 0, Readdirnames returns at most n names. In this case, if Readdirnames returns an empty slice, it will return a non-nil error explaining why. At the end of a directory, the error is io.EOF.
If n <= 0, Readdirnames returns all the names from the directory in a single slice. In this case, if Readdirnames succeeds (reads all the way to the end of the directory), it returns the slice and a nil error. If it encounters an error before the end of the directory, Readdirnames returns the names read until that point and a non-nil error.
func (*File) Seek ¶ added in v0.5.2
Seek sets the offset for the next Read or Write on file to offset, interpreted according to whence: 0 means relative to the origin of the file, 1 means relative to the current offset, and 2 means relative to the end. It returns the new offset and an error, if any. The behavior of Seek on a file opened with O_APPEND is not specified. seeking backwards invalidates the existing read buffer
func (*File) Stat ¶ added in v0.5.2
Stat returns the FileInfo structure describing file. If there is an error, it will be of type *PathError.
func (*File) Truncate ¶ added in v0.5.2
Truncate changes the size of the file. It does not change the I/O offset. If there is an error, it will be of type *PathError.
func (*File) Write ¶ added in v0.5.2
Write writes len(b) bytes to the File. It returns the number of bytes written and an error, if any. Write returns a non-nil error when n != len(b).
type FileInfo ¶ added in v0.0.3
type FileInfo struct {
// contains filtered or unexported fields
}
FileInfo implements os.FileInfo for a file in S3.
func NewFileInfo ¶ added in v0.0.3
NewFileInfo creates file cachedInfo.
func (FileInfo) Mode ¶ added in v0.0.3
Mode provides the file mode bits. For a file in S3 this defaults to 664 for files, 775 for directories. In the future this may return differently depending on the permissions available on the bucket.
type Fs ¶ added in v0.5.2
type Fs struct {
FileProps *UploadedFileProperties // FileProps define the file properties we want to set for all new files
// contains filtered or unexported fields
}
Fs is an FS object backed by S3.
func (Fs) Chmod ¶ added in v0.5.2
Chmod doesn't exists in S3. the original package did this but im not sure if we want to keep it
func (Fs) MkdirAll ¶ added in v0.5.2
MkdirAll creates a directory and all parent directories if necessary.
type GetOptions ¶ added in v0.5.3
type UploadedFileProperties ¶ added in v0.5.2
type UploadedFileProperties struct {
ACL *string // ACL defines the right to apply
CacheControl *string // CacheControl defines the Cache-Control header
ContentType *string // ContentType define the Content-Type header
}
UploadedFileProperties defines all the set properties applied to future files
Source Files