filesstore

package
v5.33.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 10, 2021 License: AGPL-3.0, Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source
const (
	TestFilePath = "/testfile"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type FileBackend

type FileBackend interface {
	TestConnection() error

	Reader(path string) (ReadCloseSeeker, error)
	ReadFile(path string) ([]byte, error)
	FileExists(path string) (bool, error)
	FileSize(path string) (int64, error)
	CopyFile(oldPath, newPath string) error
	MoveFile(oldPath, newPath string) error
	WriteFile(fr io.Reader, path string) (int64, error)
	AppendFile(fr io.Reader, path string) (int64, error)
	RemoveFile(path string) error
	FileModTime(path string) (time.Time, error)

	ListDirectory(path string) ([]string, error)
	RemoveDirectory(path string) error
}

func NewFileBackend

func NewFileBackend(settings FileBackendSettings) (FileBackend, error)

type FileBackendSettings added in v5.33.0

type FileBackendSettings struct {
	DriverName              string
	Directory               string
	AmazonS3AccessKeyId     string
	AmazonS3SecretAccessKey string
	AmazonS3Bucket          string
	AmazonS3PathPrefix      string
	AmazonS3Region          string
	AmazonS3Endpoint        string
	AmazonS3SSL             bool
	AmazonS3SignV2          bool
	AmazonS3SSE             bool
	AmazonS3Trace           bool
}

func (*FileBackendSettings) CheckMandatoryS3Fields added in v5.33.0

func (settings *FileBackendSettings) CheckMandatoryS3Fields() error

type LocalFileBackend

type LocalFileBackend struct {
	// contains filtered or unexported fields
}

func (*LocalFileBackend) AppendFile added in v5.28.0

func (b *LocalFileBackend) AppendFile(fr io.Reader, path string) (int64, error)

func (*LocalFileBackend) CopyFile

func (b *LocalFileBackend) CopyFile(oldPath, newPath string) error

func (*LocalFileBackend) FileExists

func (b *LocalFileBackend) FileExists(path string) (bool, error)

func (*LocalFileBackend) FileModTime added in v5.33.0

func (b *LocalFileBackend) FileModTime(path string) (time.Time, error)

func (*LocalFileBackend) FileSize added in v5.32.0

func (b *LocalFileBackend) FileSize(path string) (int64, error)

func (*LocalFileBackend) ListDirectory

func (b *LocalFileBackend) ListDirectory(path string) ([]string, error)

func (*LocalFileBackend) MoveFile

func (b *LocalFileBackend) MoveFile(oldPath, newPath string) error

func (*LocalFileBackend) ReadFile

func (b *LocalFileBackend) ReadFile(path string) ([]byte, error)

func (*LocalFileBackend) Reader

func (b *LocalFileBackend) Reader(path string) (ReadCloseSeeker, error)

func (*LocalFileBackend) RemoveDirectory

func (b *LocalFileBackend) RemoveDirectory(path string) error

func (*LocalFileBackend) RemoveFile

func (b *LocalFileBackend) RemoveFile(path string) error

func (*LocalFileBackend) TestConnection

func (b *LocalFileBackend) TestConnection() error

func (*LocalFileBackend) WriteFile

func (b *LocalFileBackend) WriteFile(fr io.Reader, path string) (int64, error)

type ReadCloseSeeker

type ReadCloseSeeker interface {
	io.ReadCloser
	io.Seeker
}

type S3FileBackend

type S3FileBackend struct {
	// contains filtered or unexported fields
}

S3FileBackend contains all necessary information to communicate with an AWS S3 compatible API backend.

func NewS3FileBackend added in v5.30.0

func NewS3FileBackend(settings FileBackendSettings) (*S3FileBackend, error)

NewS3FileBackend returns an instance of an S3FileBackend.

func (*S3FileBackend) AppendFile added in v5.28.0

func (b *S3FileBackend) AppendFile(fr io.Reader, path string) (int64, error)

func (*S3FileBackend) CopyFile

func (b *S3FileBackend) CopyFile(oldPath, newPath string) error

func (*S3FileBackend) FileExists

func (b *S3FileBackend) FileExists(path string) (bool, error)

func (*S3FileBackend) FileModTime added in v5.33.0

func (b *S3FileBackend) FileModTime(path string) (time.Time, error)

func (*S3FileBackend) FileSize added in v5.32.0

func (b *S3FileBackend) FileSize(path string) (int64, error)

func (*S3FileBackend) ListDirectory

func (b *S3FileBackend) ListDirectory(path string) ([]string, error)

func (*S3FileBackend) MoveFile

func (b *S3FileBackend) MoveFile(oldPath, newPath string) error

func (*S3FileBackend) ReadFile

func (b *S3FileBackend) ReadFile(path string) ([]byte, error)

func (*S3FileBackend) Reader

func (b *S3FileBackend) Reader(path string) (ReadCloseSeeker, error)

Caller must close the first return value

func (*S3FileBackend) RemoveDirectory

func (b *S3FileBackend) RemoveDirectory(path string) error

func (*S3FileBackend) RemoveFile

func (b *S3FileBackend) RemoveFile(path string) error

func (*S3FileBackend) TestConnection

func (b *S3FileBackend) TestConnection() error

func (*S3FileBackend) WriteFile

func (b *S3FileBackend) WriteFile(fr io.Reader, path string) (int64, error)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL