mrfilestorage

Documentation

Index

• Variables
• type FileProvider
  • func NewFileProvider(fs *FileSystem, rootDir string) *FileProvider
  • func (fp *FileProvider) Close() error
  • 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) Ping(ctx context.Context) 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(dirMode os.FileMode, createDirs bool, mimeTypes *mrlib.MimeTypeList) *FileSystem
  • func (f *FileSystem) CreateDirIfNotExists(rootDir, dirPath string) error
  • func (f *FileSystem) InitRootDir(path string) (bool, error)
  • func (f *FileSystem) MimeTypes() *mrlib.MimeTypeList

Variables

var ErrInvalidPath = mrerr.NewProto(
	"errMrFileStorageInvalidPath", mrerr.ErrorKindInternal, "invalid path '{{ .path }}'")

ErrInvalidPath - invalid path.

Types

type FileProvider

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

FileProvider - файловый провайдер, работающий с нативной файловой системой, позволяет читать, сохранять, удалять файлы.

func NewFileProvider

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

NewFileProvider - создаёт объект FileProvider.

func (*FileProvider) Close

func (fp *FileProvider) Close() error

Close - закрывает текущее соединение.

func (*FileProvider) Download

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

Download - comment method.

func (*FileProvider) DownloadFile

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

DownloadFile - comment method.

func (*FileProvider) Info

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

Info - comment method.

func (*FileProvider) Ping

func (fp *FileProvider) Ping(ctx context.Context) error

Ping - проверяет возможность работы с файлами.

func (*FileProvider) Remove

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

Remove - comment method.

func (*FileProvider) Upload

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

Upload - comment method.

type FileSystem

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

FileSystem - объект для работы с файлами проекта.

func New

func New(dirMode os.FileMode, createDirs bool, mimeTypes *mrlib.MimeTypeList) *FileSystem

New - создаёт объект FileSystem.

func (*FileSystem) CreateDirIfNotExists

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

CreateDirIfNotExists - comment method.

func (*FileSystem) InitRootDir

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

InitRootDir - comment method.

func (*FileSystem) MimeTypes

func (f *FileSystem) MimeTypes() *mrlib.MimeTypeList

MimeTypes - comment method.