blob

README

blob-go

Provides a common interface that blob storage providers should satisfy, as well as common implementations for Local Files and Google Cloud Storage.

Documentation

Index

• type Fs
  • func NewFsStorage(basePath string) *Fs
  • func (l *Fs) Read(ctx context.Context, key string) ([]byte, error)
  • func (l *Fs) Remove(ctx context.Context, key string) error
  • func (l *Fs) RemoveFolder(ctx context.Context, folder string) error
  • func (l *Fs) Write(ctx context.Context, key string, data []byte) error
  • func (l *Fs) WriteIfMissing(ctx context.Context, key string, data []byte) error
• type Gcs
  • func NewGcsStorage(ctx context.Context, bucket string, prefix string) (*Gcs, error)
  • func (g *Gcs) Read(ctx context.Context, key string) ([]byte, error)
  • func (g *Gcs) Remove(ctx context.Context, key string) error
  • func (g *Gcs) RemoveFolder(ctx context.Context, folder string) error
  • func (g *Gcs) Write(ctx context.Context, key string, data []byte) error
  • func (g *Gcs) WriteIfMissing(ctx context.Context, key string, data []byte) error
• type Storage

Types

type Fs

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

Implements the Storage interface for the local file system.

func NewFsStorage

func NewFsStorage(basePath string) *Fs

Returns a new Fs instance.

func (*Fs) Read

func (l *Fs) Read(ctx context.Context, key string) ([]byte, error)

Reads a blob from the local file system.

func (*Fs) Remove

func (l *Fs) Remove(ctx context.Context, key string) error

Removes a blob from the local file system.

func (*Fs) RemoveFolder

func (l *Fs) RemoveFolder(ctx context.Context, folder string) error

Removes a folder

func (*Fs) Write

func (l *Fs) Write(ctx context.Context, key string, data []byte) error

Writes a blob to the local file system.

func (*Fs) WriteIfMissing

func (l *Fs) WriteIfMissing(ctx context.Context, key string, data []byte) error

Writes a blob to the local file system if the key does not contain any data yet

type Gcs

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

Gcs implements Storage for Google Cloud Storage.

func NewGcsStorage

func NewGcsStorage(ctx context.Context, bucket string, prefix string) (*Gcs, error)

Returns a new Gcs blob storage instance.

func (*Gcs) Read

func (g *Gcs) Read(ctx context.Context, key string) ([]byte, error)

Reads a blob from Google Cloud Storage.

func (*Gcs) Remove

func (g *Gcs) Remove(ctx context.Context, key string) error

Remove removes a blob from Google Cloud Storage.

func (*Gcs) RemoveFolder

func (g *Gcs) RemoveFolder(ctx context.Context, folder string) error

Removes all objects at the specified folder (prefix)

func (*Gcs) Write

func (g *Gcs) Write(ctx context.Context, key string, data []byte) error

Writes a blob to Google Cloud Storage.

func (*Gcs) WriteIfMissing

func (g *Gcs) WriteIfMissing(ctx context.Context, key string, data []byte) error

Writes a blob to Google Cloud Storage if the key does not contain any data yet

type Storage

type Storage interface {
	// Reads a blob
	Read(ctx context.Context, key string) ([]byte, error)
	// Writes a blob
	Write(ctx context.Context, key string, data []byte) error
	// Writes a blob if the key does not contain any data yet
	WriteIfMissing(ctx context.Context, key string, data []byte) error
	// Removes a blob if it exists
	Remove(ctx context.Context, key string) error
	// Removes a folder and all children blobs
	RemoveFolder(ctx context.Context, folder string) error
}

A simplified interface for interacting with blob storage.