storage

Documentation

Index

• Variables
• type FilePointer
  • func (f *FilePointer) Close() error
• type Metadata
• type Params
• type Result
  • func New(p Params) (r Result, err error)
• type Storage
  • func (o *Storage) DeleteFile(ctx context.Context, path string) error
  • func (o *Storage) FileExists(ctx context.Context, path string) (ok bool, err error)
  • func (o *Storage) Migrate() error
  • func (o *Storage) ReadFile(ctx context.Context, path string) (*FilePointer, error)
  • func (o *Storage) WriteFile(ctx context.Context, opts *WriteFileOptions) error
• type WriteFileOptions

Variables

var ErrAlreadyExists = errors.New("file already exists")

Types

type FilePointer

type FilePointer struct {
	File     *os.File
	Metadata *Metadata
}

func (*FilePointer) Close

func (f *FilePointer) Close() error

type Metadata

type Metadata struct {
	Class    string    `cbor:"c"`
	Oneshot  bool      `cbor:"o"`
	MimeType string    `cbor:"m"`
	Expiry   time.Time `cbor:"e"`
}

type Params

type Params struct {
	fx.In

	Loader *config.Loader
	Ctx    context.Context
	Lc     fx.Lifecycle
	Log    *slog.Logger
}

type Result

type Result struct {
	fx.Out

	Output *Storage
}

func New

func New(p Params) (r Result, err error)

type Storage

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

func (*Storage) DeleteFile

func (o *Storage) DeleteFile(ctx context.Context, path string) error

func (*Storage) FileExists

func (o *Storage) FileExists(ctx context.Context, path string) (ok bool, err error)

func (*Storage) Migrate

func (o *Storage) Migrate() error

func (*Storage) ReadFile

func (o *Storage) ReadFile(ctx context.Context, path string) (*FilePointer, error)

the caller is responsible to close the filepointer

func (*Storage) WriteFile

func (o *Storage) WriteFile(ctx context.Context, opts *WriteFileOptions) error

type WriteFileOptions

type WriteFileOptions struct {
	File     io.Reader
	Name     string
	Metadata *Metadata
}