filestore

type File interface {
	// Name returns file name with extension.
	Name() string
	// Bucket returns file's bucket.
	Bucket() string
	// Directory returns file directory.
	Directory() string
	// Version returns file version.
	Version() string

	// Parameters obtainable after open.
	// ModifiedAt is the last modification time.
	ModifiedAt() time.Time
	// Size returns byte size of given file.
	Size() int64

	// I/O
	//
	// Read functions.
	//
	// Open opens the file in an read-only way.
	Open(ctx context.Context) error
	// Close after successful read the file needs to be closed.
	Close(ctx context.Context) error
	// Read the file content when it is opened. Implements io.Reader
	Read(data []byte) (int, error)

	// Write the file content Implements io.Writer. The write is independent of the Open -> Read -> Close cycle.
	// In order to store the changes the file needs to be put into the store.
	Write(data []byte) (int, error)
}

type FileOption func(o *FileOptions)

type FileOptions struct {
	Directory string
	Bucket    string
}

type GetOption func(o *GetOptions)

type GetOptions struct {
	Directory string
	Bucket    string
	Version   string
}

type ListOption func(o *ListOptions)

type ListOptions struct {
	// Limit, Offset sets the limit and offset while listing the files.
	Limit, Offset int
	// Extension is a filter type of the file extension.
	Extension string
	// Bucket could be used for S3 implementations.
	Bucket string
}

type Metadater interface {
	Metadata() map[string]interface{}
	GetMeta(key string) (interface{}, bool)
	SetMeta(key string, value interface{})
}

type Model interface {
	mapping.Model
	// BucketField returns golang name for the bucket field.
	BucketField() string
	// DirectoryField returns golang name for the directory field.
	DirectoryField() string
	// NameField returns golang name for the file name field.
	NameField() string
	// VersionField returns golang name for the version field.
	VersionField() string
	// ExtensionField returns golang name for the file extension field.
	ExtensionField() string
}

type PutOption func(o *PutOptions)

type PutOptions struct {
	// Overwrite defines if the file with given version should be overwritten by the input.
	Overwrite bool
}

type Store interface {
	// Type returns the name of the file store.
	Type() string
	// NewFile creates new file with given name and with provided options.
	NewFile(ctx context.Context, name string, options ...FileOption) (File, error)
	// PutFile stores the file created previously.
	PutFile(ctx context.Context, file File, options ...PutOption) error
	// GetFile gets the file header with provided name (only file name with extension) and possible options.
	GetFile(ctx context.Context, name string, options ...GetOption) (File, error)
	// ListFiles lists the file headers for provided directory with optional filters.
	ListFiles(ctx context.Context, dir string, options ...ListOption) ([]File, error)
	// DeleteFile deletes provided file.
	DeleteFile(ctx context.Context, file File) error
}