blob

type Attributes struct {
	Key     string
	Size    int64
	ModTime time.Time
	// MD5 is the MD5 of the content; empty when the driver has no digest for the object (ADR-0159).
	MD5         []byte
	ContentType string
	Metadata    map[string]string // user metadata, lowercase keys
}

type Bucket interface {
	Get(ctx context.Context, key string) ([]byte, error)
	Put(ctx context.Context, key string, data []byte, opts PutOptions) error
	Delete(ctx context.Context, key string) error
	Exists(ctx context.Context, key string) (bool, error)
	List(ctx context.Context, prefix string) ([]Attributes, error)
	// ListAfter returns at most limit objects under prefix whose key sorts strictly after `after`, sorted by key,
	// with the fields List fills; more is true exactly when a further key under prefix exists. limit < 1 is
	// fault.Invalid (ADR-0184).
	ListAfter(ctx context.Context, prefix, after string, limit int) (items []Attributes, more bool, err error)
	// Attributes reads one object's attributes without its content; fault.NotFound if absent.
	Attributes(ctx context.Context, key string) (Attributes, error)
	SignedURL(ctx context.Context, key string, opts SignOptions) (string, error)
	Close() error
}

type PutOptions struct {
	ContentType string
	Metadata    map[string]string
	// IfNotExist creates the object only when its key is absent; a present key is fault.Conflict and the object
	// stays unchanged (ADR-0203).
	IfNotExist bool
}

type RangeReader interface {
	// GetRange returns bytes [offset, offset+length) of the object at key.
	// A negative length means "to end". offset must be >= 0. fault.NotFound if the
	// key is absent; fault.Invalid for a negative offset.
	GetRange(ctx context.Context, key string, offset, length int64) ([]byte, error)
}

type RestoreReport struct {
	Copied, Deleted, Unchanged int
	NoVersion                  []string
}

type SignMethod string

type SignOptions struct {
	Method SignMethod
	Expiry time.Duration
}

type Versioned interface {
	// Versioning reads the bucket's versioning status and Object Lock configuration (ADR-0208 Decision 2).
	Versioning(ctx context.Context) (Versioning, error)
	// RestoreAt makes every key under the store's prefix hold its version at at (Decision 6): keep is
	// blob.versionRetention, and 0 or an at older than keep is fault.Invalid. No version is removed.
	RestoreAt(ctx context.Context, at time.Time, keep time.Duration) (RestoreReport, error)
}

type Versioning struct{ Enabled, ObjectLock bool }