mrfilestorage

Documentation

Index

• Variables
• type FileProvider
  • func NewFileProvider(fs *FileSystem, rootDir string) *FileProvider
  • func (fp *FileProvider) Download(ctx context.Context, filePath string) (mrtype.File, error)
  • func (fp *FileProvider) DownloadFile(ctx context.Context, filePath string) (io.ReadCloser, error)
  • func (fp *FileProvider) Info(ctx context.Context, filePath string) (mrtype.FileInfo, error)
  • func (fp *FileProvider) Remove(ctx context.Context, filePath string) error
  • func (fp *FileProvider) Upload(ctx context.Context, file mrtype.File) error
• type FileSystem
  • func New(opt Options) *FileSystem
  • func (f *FileSystem) CreateDirIfNotExists(rootDir string, dirPath string) error
  • func (f *FileSystem) InitRootDir(path string) (bool, error)
• type Options

Variables

var (
	FactoryErrInvalidPath = mrerr.NewFactoryWithCaller(
		"errMrFileStorageInvalidPath", mrerr.ErrorKindInternal, "invalid path '{{ .path }}'")
)

Types

type FileProvider

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

func NewFileProvider

func NewFileProvider(fs *FileSystem, rootDir string) *FileProvider

func (*FileProvider) Download

func (fp *FileProvider) Download(ctx context.Context, filePath string) (mrtype.File, error)

func (*FileProvider) DownloadFile

func (fp *FileProvider) DownloadFile(ctx context.Context, filePath string) (io.ReadCloser, error)

func (*FileProvider) Info

func (fp *FileProvider) Info(ctx context.Context, filePath string) (mrtype.FileInfo, error)

func (*FileProvider) Remove

func (fp *FileProvider) Remove(ctx context.Context, filePath string) error

func (*FileProvider) Upload

func (fp *FileProvider) Upload(ctx context.Context, file mrtype.File) error

type FileSystem

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

func New

func New(opt Options) *FileSystem

func (*FileSystem) CreateDirIfNotExists

func (f *FileSystem) CreateDirIfNotExists(rootDir string, dirPath string) error

func (*FileSystem) InitRootDir

func (f *FileSystem) InitRootDir(path string) (bool, error)

type Options

type Options struct {
	DirMode    os.FileMode
	CreateDirs bool
}