storage

type Adapter ¶

type Adapter interface {
	Exists(ctx context.Context, endpoint, oid string) (bool, error)
	Get(ctx context.Context, endpoint, oid string) (io.ReadCloser, int64, error)
	Put(ctx context.Context, endpoint, oid string, reader io.Reader) error
	Size(ctx context.Context, endpoint, oid string) (int64, error)
	AvailableSpace(ctx context.Context) (uint64, error)
}

Adapter is the interface for object storage backends.

All methods accept a context.Context for cancellation. Implementations should check ctx.Err() before starting work. For streaming operations like Put, the context may not be monitored during I/O — callers should not rely on context cancellation to immediately abort an in-progress write. Network-backed implementations (e.g., S3) should propagate the context into their underlying client calls.

Put does not enforce a size limit on the reader. Callers are responsible for wrapping the reader with an appropriate limit (e.g., http.MaxBytesReader) before passing it to Put.

type Local ¶

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

Local stores objects on the local filesystem.

func NewLocal(basePath string) *Local

func (l *Local) AvailableSpace(ctx context.Context) (uint64, error)

func (l *Local) Exists(ctx context.Context, endpoint, oid string) (bool, error)

func (l *Local) Get(ctx context.Context, endpoint, oid string) (io.ReadCloser, int64, error)

func (l *Local) Put(ctx context.Context, endpoint, oid string, reader io.Reader) error

func (l *Local) Size(ctx context.Context, endpoint, oid string) (int64, error)

type PresignedURLProvider ¶

type PresignedURLProvider interface {
	PresignGet(ctx context.Context, endpoint, oid string, expiry time.Duration) (href string, err error)
	PresignPut(ctx context.Context, endpoint, oid string, expiry time.Duration) (href string, err error)
}

PresignedURLProvider is an optional interface that storage adapters can implement to provide presigned URLs for direct client-to-storage transfers. When an adapter implements this interface, the batch handler uses the presigned URLs instead of generating HMAC-signed proxy URLs. The local filesystem adapter does not implement this interface.

type S3 ¶

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

S3 stores objects in an S3-compatible bucket. It supports both AWS S3 and Cloudflare R2 through configurable endpoint and path style options.

func NewS3(ctx context.Context, cfg S3Config) (*S3, error)

func (s *S3) AvailableSpace(_ context.Context) (uint64, error)

func (s *S3) Exists(ctx context.Context, endpoint, oid string) (bool, error)

func (s *S3) Get(ctx context.Context, endpoint, oid string) (io.ReadCloser, int64, error)

func (s *S3) PresignGet(ctx context.Context, endpoint, oid string, expiry time.Duration) (string, error)

func (s *S3) PresignPut(ctx context.Context, endpoint, oid string, expiry time.Duration) (string, error)

func (s *S3) Put(ctx context.Context, endpoint, oid string, reader io.Reader) error

func (s *S3) Size(ctx context.Context, endpoint, oid string) (int64, error)

type S3Config ¶

type S3Config struct {
	Bucket          string
	Region          string
	Endpoint        string
	AccessKeyID     string
	SecretAccessKey string
	Prefix          string
	PresignedURLs   bool
	ForcePathStyle  bool
}

S3Config holds the settings for creating an S3 storage adapter.