filesystem

Documentation

Index

• type Bucket
  • func NewBucket(rootDir string) (*Bucket, error)
  • func NewBucketFromConfig(conf []byte) (*Bucket, error)
  • func (b *Bucket) Close() error
  • func (b *Bucket) Delete(_ context.Context, name string) error
  • func (b *Bucket) Exists(_ context.Context, name string) (bool, error)
  • func (b *Bucket) Get(ctx context.Context, name string) (io.ReadCloser, error)
  • func (b *Bucket) GetRange(_ context.Context, name string, off, length int64) (io.ReadCloser, error)
  • func (b *Bucket) IsObjNotFoundErr(err error) bool
  • func (b *Bucket) Iter(ctx context.Context, dir string, f func(string) error) error
  • func (b *Bucket) Name() string
  • func (b *Bucket) ObjectSize(_ context.Context, name string) (uint64, error)
  • func (b *Bucket) Upload(_ context.Context, name string, r io.Reader) (err error)
• type Config

Types

type Bucket

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

Bucket implements the objstore.Bucket interfaces against filesystem that binary runs on. Methods from Bucket interface are thread-safe. Objects are assumed to be immutable. NOTE: It does not follow symbolic links.

func NewBucket

func NewBucket(rootDir string) (*Bucket, error)

NewBucket returns a new filesystem.Bucket.

func NewBucketFromConfig

func NewBucketFromConfig(conf []byte) (*Bucket, error)

NewBucketFromConfig returns a new filesystem.Bucket from config.

func (*Bucket) Close

func (b *Bucket) Close() error

func (*Bucket) Delete

func (b *Bucket) Delete(_ context.Context, name string) error

Delete removes all data prefixed with the dir.

func (*Bucket) Exists

func (b *Bucket) Exists(_ context.Context, name string) (bool, error)

Exists checks if the given directory exists in memory.

func (*Bucket) Get

func (b *Bucket) Get(ctx context.Context, name string) (io.ReadCloser, error)

Get returns a reader for the given object name.

func (*Bucket) GetRange

func (b *Bucket) GetRange(_ context.Context, name string, off, length int64) (io.ReadCloser, error)

GetRange returns a new range reader for the given object name and range.

func (*Bucket) IsObjNotFoundErr

func (b *Bucket) IsObjNotFoundErr(err error) bool

IsObjNotFoundErr returns true if error means that object is not found. Relevant to Get operations.

func (*Bucket) Iter

func (b *Bucket) Iter(ctx context.Context, dir string, f func(string) error) error

Iter calls f for each entry in the given directory. The argument to f is the full object name including the prefix of the inspected directory.

func (*Bucket) Name

func (b *Bucket) Name() string

Name returns the bucket name.

func (*Bucket) ObjectSize

func (b *Bucket) ObjectSize(_ context.Context, name string) (uint64, error)

ObjectSize returns the size of the specified object.

func (*Bucket) Upload

func (b *Bucket) Upload(_ context.Context, name string, r io.Reader) (err error)

Upload writes the file specified in src to into the memory.

type Config

type Config struct {
	Directory string `yaml:"directory"`
}

Config stores the configuration for storing and accessing blobs in filesystem.