blobfs

README

blobfs

Like ioutil but for various cloud object stores like AWS S3, GCS, etc. using GoCloud.

Documentation

Index

• func CreateBucketURL(bucketURL, endpoint, region string) string
• type BlobFS
  • func New(storageURL string, prefix ...string) *BlobFS
  • func (fs *BlobFS) DeleteFile(ctx context.Context, filepath string) (err error)
  • func (fs *BlobFS) Exists(ctx context.Context, filepath string) (exists bool, err error)
  • func (fs *BlobFS) OpenBucket(ctx context.Context, dir string) (bucket *blob.Bucket, err error)
  • func (fs *BlobFS) ReadFile(ctx context.Context, filepath string) (bytes []byte, err error)
  • func (fs *BlobFS) SignedURL(ctx context.Context, filepath string, opts *blob.SignedURLOptions) (url string, err error)
  • func (fs *BlobFS) WithCACert(caCert []byte) *BlobFS
  • func (fs *BlobFS) WithMetricsHook(metricsHook TelemetryHook) *BlobFS
  • func (fs *BlobFS) WriteFile(ctx context.Context, filepath string, data []byte) (err error)
• type Interface
  • func NewInMemoryFS() Interface
  • func NewOsFs() Interface
• type Operation
  • func (op Operation) String() string
• type TelemetryHook

Functions

func CreateBucketURL

func CreateBucketURL(bucketURL, endpoint, region string) string

Types

type BlobFS

type BlobFS struct {
	CACert []byte
	// contains filtered or unexported fields
}

BlobFS provides a filesystem abstraction over various blob storage backends

func New

func New(storageURL string, prefix ...string) *BlobFS

func (*BlobFS) DeleteFile

func (fs *BlobFS) DeleteFile(ctx context.Context, filepath string) (err error)

func (*BlobFS) Exists

func (fs *BlobFS) Exists(ctx context.Context, filepath string) (exists bool, err error)

func (*BlobFS) OpenBucket

func (fs *BlobFS) OpenBucket(ctx context.Context, dir string) (bucket *blob.Bucket, err error)

func (*BlobFS) ReadFile

func (fs *BlobFS) ReadFile(ctx context.Context, filepath string) (bytes []byte, err error)

func (*BlobFS) SignedURL

func (fs *BlobFS) SignedURL(ctx context.Context, filepath string, opts *blob.SignedURLOptions) (url string, err error)

func (*BlobFS) WithCACert

func (fs *BlobFS) WithCACert(caCert []byte) *BlobFS

func (*BlobFS) WithMetricsHook

func (fs *BlobFS) WithMetricsHook(metricsHook TelemetryHook) *BlobFS

WithMetricsHook adds a telemetry hook to the BlobFS instance. NOTE: Any telemetry hook must be registered right after calling New() NOT safe for concurrent use

func (*BlobFS) WriteFile

func (fs *BlobFS) WriteFile(ctx context.Context, filepath string, data []byte) (err error)

type Interface

type Interface interface {
	WriteFile(ctx context.Context, filepath string, data []byte) error
	ReadFile(ctx context.Context, filepath string) ([]byte, error)
	DeleteFile(ctx context.Context, filepath string) error
	Exists(ctx context.Context, filepath string) (bool, error)
	SignedURL(ctx context.Context, filepath string, opts *blob.SignedURLOptions) (string, error)
	OpenBucket(ctx context.Context, dir string) (*blob.Bucket, error)
}

func NewInMemoryFS

func NewInMemoryFS() Interface

func NewOsFs

func NewOsFs() Interface

type Operation

type Operation int

Operation represents a filesystem operation

const (
	Write Operation = iota
	Read
	Delete
	Exists
	SignedURL
	OpenBucket
)

func (Operation) String

func (op Operation) String() string

type TelemetryHook

type TelemetryHook func(
	ctx context.Context,
	op Operation,
	dirName string,
	fileName string,
	storageType string,
	err error,
)

TelemetryHook is invoked after each filesystem operation It is intended for metrics, tracing, and observability