filestore

Documentation

Index

• type FileStore
• type Module
  • func Init(auth *auth.Module) *Module
  • func (m *Module) CreateDir(ctx context.Context, project, token string, req *model.CreateFileRequest) (int, error)
  • func (m *Module) DeleteFile(ctx context.Context, project, token, path string) (int, error)
  • func (m *Module) DownloadFile(ctx context.Context, project, token, path string) (int, *model.File, error)
  • func (m *Module) IsEnabled() bool
  • func (m *Module) ListFiles(ctx context.Context, project, token string, req *model.ListFilesRequest) (int, []*model.ListFilesResponse, error)
  • func (m *Module) SetConfig(conf *config.FileStore) error
  • func (m *Module) UploadFile(ctx context.Context, project, token string, req *model.CreateFileRequest, ...) (int, error)

Types

type FileStore

type FileStore interface {
	CreateFile(ctx context.Context, project string, req *model.CreateFileRequest, file io.Reader) error
	CreateDir(ctx context.Context, project string, req *model.CreateFileRequest) error

	ListDir(ctx context.Context, project string, req *model.ListFilesRequest) ([]*model.ListFilesResponse, error)
	ReadFile(ctx context.Context, project, path string) (*model.File, error)

	DeleteDir(ctx context.Context, project, path string) error
	DeleteFile(ctx context.Context, project, path string) error

	GetStoreType() utils.FileStoreType
	Close() error
}

FileStore abstracts the implementation file storage operations

type Module

type Module struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Module is responsible for managing the file storage module

func Init

func Init(auth *auth.Module) *Module

Init creates a new instance of the file store object

func (*Module) CreateDir

func (m *Module) CreateDir(ctx context.Context, project, token string, req *model.CreateFileRequest) (int, error)

CreateDir creates a directory at the provided path

func (*Module) DeleteFile

func (m *Module) DeleteFile(ctx context.Context, project, token, path string) (int, error)

DeleteFile deletes a file at the provided path

func (*Module) DownloadFile

func (m *Module) DownloadFile(ctx context.Context, project, token, path string) (int, *model.File, error)

DownloadFile downloads a file from the provided path

func (*Module) IsEnabled

func (m *Module) IsEnabled() bool

IsEnabled checks if the file store module is enabled

func (*Module) ListFiles

func (m *Module) ListFiles(ctx context.Context, project, token string, req *model.ListFilesRequest) (int, []*model.ListFilesResponse, error)

ListFiles lists all the files in the provided path

func (*Module) SetConfig

func (m *Module) SetConfig(conf *config.FileStore) error

SetConfig set the rules and secret key required by the crud block

func (*Module) UploadFile

func (m *Module) UploadFile(ctx context.Context, project, token string, req *model.CreateFileRequest, reader io.Reader) (int, error)

UploadFile uploads a file to the provided path