60 lines
1.6 KiB
Go
60 lines
1.6 KiB
Go
// Copyright (C) 2019 Storj Labs, Inc.
|
|
// See LICENSE for copying information.
|
|
|
|
package storage
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
|
|
"github.com/zeebo/errs"
|
|
)
|
|
|
|
// ErrInvalidBlobRef is returned when an blob reference is invalid
|
|
var ErrInvalidBlobRef = errs.Class("invalid blob ref")
|
|
|
|
// BlobRef is a reference to a blob
|
|
type BlobRef struct {
|
|
Namespace []byte
|
|
Key []byte
|
|
}
|
|
|
|
// IsValid returns whether both namespace and key are specified
|
|
func (ref *BlobRef) IsValid() bool {
|
|
return len(ref.Namespace) > 0 && len(ref.Key) > 0
|
|
}
|
|
|
|
// BlobReader is an interface that groups Read, ReadAt, Seek and Close.
|
|
type BlobReader interface {
|
|
io.Reader
|
|
io.ReaderAt
|
|
io.Seeker
|
|
io.Closer
|
|
// Size returns the size of the blob
|
|
Size() (int64, error)
|
|
}
|
|
|
|
// BlobWriter is an interface that groups Read, ReadAt, Seek and Close.
|
|
type BlobWriter interface {
|
|
io.Writer
|
|
// Cancel discards the blob.
|
|
Cancel(context.Context) error
|
|
// Commit ensures that the blob is readable by others.
|
|
Commit(context.Context) error
|
|
// Size returns the size of the blob
|
|
Size() (int64, error)
|
|
}
|
|
|
|
// Blobs is a blob storage interface
|
|
type Blobs interface {
|
|
// Create creates a new blob that can be written
|
|
// optionally takes a size argument for performance improvements, -1 is unknown size
|
|
Create(ctx context.Context, ref BlobRef, size int64) (BlobWriter, error)
|
|
// Open opens a reader with the specified namespace and key
|
|
Open(ctx context.Context, ref BlobRef) (BlobReader, error)
|
|
// Delete deletes the blob with the namespace and key
|
|
Delete(ctx context.Context, ref BlobRef) error
|
|
// FreeSpace return how much free space left for writing
|
|
FreeSpace() (int64, error)
|
|
}
|