filesstore

Documentation

Index

• Constants
• func CheckMandatoryS3Fields(settings *model.FileSettings) *model.AppError
• type FileBackend
  • func NewFileBackend(settings *model.FileSettings, enableComplianceFeatures bool) (FileBackend, *model.AppError)
• type LocalFileBackend
  • func (b *LocalFileBackend) AppendFile(fr io.Reader, path string) (int64, *model.AppError)
  • func (b *LocalFileBackend) CopyFile(oldPath, newPath string) *model.AppError
  • func (b *LocalFileBackend) FileExists(path string) (bool, *model.AppError)
  • func (b *LocalFileBackend) ListDirectory(path string) (*[]string, *model.AppError)
  • func (b *LocalFileBackend) MoveFile(oldPath, newPath string) *model.AppError
  • func (b *LocalFileBackend) ReadFile(path string) ([]byte, *model.AppError)
  • func (b *LocalFileBackend) Reader(path string) (ReadCloseSeeker, *model.AppError)
  • func (b *LocalFileBackend) RemoveDirectory(path string) *model.AppError
  • func (b *LocalFileBackend) RemoveFile(path string) *model.AppError
  • func (b *LocalFileBackend) TestConnection() *model.AppError
  • func (b *LocalFileBackend) WriteFile(fr io.Reader, path string) (int64, *model.AppError)
• type ReadCloseSeeker
• type S3FileBackend
  • func NewS3FileBackend(settings *model.FileSettings, enableComplianceFeatures bool) (*S3FileBackend, error)
  • func (b *S3FileBackend) AppendFile(fr io.Reader, path string) (int64, *model.AppError)
  • func (b *S3FileBackend) CopyFile(oldPath, newPath string) *model.AppError
  • func (b *S3FileBackend) FileExists(path string) (bool, *model.AppError)
  • func (b *S3FileBackend) ListDirectory(path string) (*[]string, *model.AppError)
  • func (b *S3FileBackend) MoveFile(oldPath, newPath string) *model.AppError
  • func (b *S3FileBackend) ReadFile(path string) ([]byte, *model.AppError)
  • func (b *S3FileBackend) Reader(path string) (ReadCloseSeeker, *model.AppError)
  • func (b *S3FileBackend) RemoveDirectory(path string) *model.AppError
  • func (b *S3FileBackend) RemoveFile(path string) *model.AppError
  • func (b *S3FileBackend) TestConnection() *model.AppError
  • func (b *S3FileBackend) WriteFile(fr io.Reader, path string) (int64, *model.AppError)

Constants

const (
	TEST_FILE_PATH = "/testfile"
)

Functions

func CheckMandatoryS3Fields

func CheckMandatoryS3Fields(settings *model.FileSettings) *model.AppError

Types

type FileBackend

type FileBackend interface {
	TestConnection() *model.AppError

	Reader(path string) (ReadCloseSeeker, *model.AppError)
	ReadFile(path string) ([]byte, *model.AppError)
	FileExists(path string) (bool, *model.AppError)
	CopyFile(oldPath, newPath string) *model.AppError
	MoveFile(oldPath, newPath string) *model.AppError
	WriteFile(fr io.Reader, path string) (int64, *model.AppError)
	AppendFile(fr io.Reader, path string) (int64, *model.AppError)
	RemoveFile(path string) *model.AppError

	ListDirectory(path string) (*[]string, *model.AppError)
	RemoveDirectory(path string) *model.AppError
}

func NewFileBackend

func NewFileBackend(settings *model.FileSettings, enableComplianceFeatures bool) (FileBackend, *model.AppError)

type LocalFileBackend

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

func (*LocalFileBackend) AppendFile

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

func (*LocalFileBackend) CopyFile

func (b *LocalFileBackend) CopyFile(oldPath, newPath string) *model.AppError

func (*LocalFileBackend) FileExists

func (b *LocalFileBackend) FileExists(path string) (bool, *model.AppError)

func (*LocalFileBackend) ListDirectory

func (b *LocalFileBackend) ListDirectory(path string) (*[]string, *model.AppError)

func (*LocalFileBackend) MoveFile

func (b *LocalFileBackend) MoveFile(oldPath, newPath string) *model.AppError

func (*LocalFileBackend) ReadFile

func (b *LocalFileBackend) ReadFile(path string) ([]byte, *model.AppError)

func (*LocalFileBackend) Reader

func (b *LocalFileBackend) Reader(path string) (ReadCloseSeeker, *model.AppError)

func (*LocalFileBackend) RemoveDirectory

func (b *LocalFileBackend) RemoveDirectory(path string) *model.AppError

func (*LocalFileBackend) RemoveFile

func (b *LocalFileBackend) RemoveFile(path string) *model.AppError

func (*LocalFileBackend) TestConnection

func (b *LocalFileBackend) TestConnection() *model.AppError

func (*LocalFileBackend) WriteFile

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

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

func NewS3FileBackend(settings *model.FileSettings, enableComplianceFeatures bool) (*S3FileBackend, error)

NewS3FileBackend returns an instance of an S3FileBackend.

func (*S3FileBackend) AppendFile

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

func (*S3FileBackend) CopyFile

func (b *S3FileBackend) CopyFile(oldPath, newPath string) *model.AppError

func (*S3FileBackend) FileExists

func (b *S3FileBackend) FileExists(path string) (bool, *model.AppError)

func (*S3FileBackend) ListDirectory

func (b *S3FileBackend) ListDirectory(path string) (*[]string, *model.AppError)

func (*S3FileBackend) MoveFile

func (b *S3FileBackend) MoveFile(oldPath, newPath string) *model.AppError

func (*S3FileBackend) ReadFile

func (b *S3FileBackend) ReadFile(path string) ([]byte, *model.AppError)

func (*S3FileBackend) Reader

func (b *S3FileBackend) Reader(path string) (ReadCloseSeeker, *model.AppError)

Caller must close the first return value

func (*S3FileBackend) RemoveDirectory

func (b *S3FileBackend) RemoveDirectory(path string) *model.AppError

func (*S3FileBackend) RemoveFile

func (b *S3FileBackend) RemoveFile(path string) *model.AppError

func (*S3FileBackend) TestConnection

func (b *S3FileBackend) TestConnection() *model.AppError

func (*S3FileBackend) WriteFile

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