Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

dstore

package module

Go to main page

Versions in this module

v0

v0.2.2

Mar 30, 2026

v0.2.1

Mar 25, 2026

v0.2.0

Mar 24, 2026

v0.1.2

Dec 30, 2025

v0.1.1

Dec 30, 2025

Changes in this version

+ var ErrMetadataNotSupported = errors.New("metadata is not supported by local file system store")

+ var ErrNotFound = errors.New("not found")

+ var NewStoreFromURL = NewStoreFromFileURL

+ var StopIteration = errors.New("stop iteration")

+ func FileNameFromContext(ctx context.Context) string

+ func ParseS3URL(s3URL *url.URL) (config *aws.Config, bucket, path, storageClass string, err error)

+ func ReadObject(ctx context.Context, fileURL string, opts ...Option) ([]byte, error)

+ func StoreTypeFromContext(ctx context.Context) string

+ type AzureStore struct

+ func NewAzureStore(baseURL *url.URL, extension, compressionType string, overwrite bool, ...) (*AzureStore, error)

+ func (c AzureStore) Overwrite() bool

+ func (c AzureStore) SetMeter(meter Meter)

+ func (c AzureStore) SetOverwrite(in bool)

+ func (s *AzureStore) BaseURL() *url.URL

+ func (s *AzureStore) Clone(ctx context.Context, opts ...Option) (Store, error)

+ func (s *AzureStore) CopyObject(ctx context.Context, src, dest string) error

+ func (s *AzureStore) DeleteObject(ctx context.Context, base string) error

+ func (s *AzureStore) FileExists(ctx context.Context, base string) (bool, error)

+ func (s *AzureStore) ListFiles(ctx context.Context, prefix string, max int) ([]string, error)

+ func (s *AzureStore) ObjectAttributes(ctx context.Context, base string) (*ObjectAttributes, error)

+ func (s *AzureStore) ObjectPath(name string) string

+ func (s *AzureStore) ObjectURL(name string) string

+ func (s *AzureStore) OpenObject(ctx context.Context, name string) (out io.ReadCloser, err error)

+ func (s *AzureStore) PushLocalFile(ctx context.Context, localFile, toBaseName string) error

+ func (s *AzureStore) SetMetadata(ctx context.Context, base string, metadata map[string]string) error

+ func (s *AzureStore) SubStore(subFolder string) (Store, error)

+ func (s *AzureStore) Walk(ctx context.Context, prefix string, f func(filename string) (err error)) error

+ func (s *AzureStore) WalkFrom(ctx context.Context, prefix, startingPoint string, ...) error

+ func (s *AzureStore) WalkFromTo(ctx context.Context, prefix, startingPoint, exclusiveEndPoint string, ...) error

+ func (s *AzureStore) WriteObject(ctx context.Context, base string, f io.Reader, metadataKeyValues ...string) (err error)

+ type BufferedFileReadCloser struct

+ func NewBufferedFileReadCloser(file *os.File) *BufferedFileReadCloser

+ func (readCloser *BufferedFileReadCloser) Close() error

+ func (readCloser *BufferedFileReadCloser) Read(p []byte) (n int, err error)

+ type Clonable interface

+ Clone func(ctx context.Context, opts ...Option) (Store, error)

+ type GSStore struct

+ func NewGSStore(baseURL *url.URL, extension, compressionType string, overwrite bool, ...) (*GSStore, error)

+ func (c GSStore) Overwrite() bool

+ func (c GSStore) SetMeter(meter Meter)

+ func (c GSStore) SetOverwrite(in bool)

+ func (s *GSStore) BaseURL() *url.URL

+ func (s *GSStore) Clone(ctx context.Context, opts ...Option) (Store, error)

+ func (s *GSStore) CopyObject(ctx context.Context, src, dest string) error

+ func (s *GSStore) DeleteObject(ctx context.Context, base string) error

+ func (s *GSStore) FileExists(ctx context.Context, base string) (bool, error)

+ func (s *GSStore) ListFiles(ctx context.Context, prefix string, max int) ([]string, error)

+ func (s *GSStore) ObjectAttributes(ctx context.Context, base string) (*ObjectAttributes, error)

+ func (s *GSStore) ObjectPath(name string) string

+ func (s *GSStore) ObjectURL(name string) string

+ func (s *GSStore) OpenObject(ctx context.Context, name string) (out io.ReadCloser, err error)

+ func (s *GSStore) PushLocalFile(ctx context.Context, localFile, toBaseName string) error

+ func (s *GSStore) SetMetadata(ctx context.Context, base string, metadata map[string]string) error

+ func (s *GSStore) SubStore(subFolder string) (Store, error)

+ func (s *GSStore) Walk(ctx context.Context, prefix string, f func(filename string) (err error)) error

+ func (s *GSStore) WalkFrom(ctx context.Context, prefix, startingPoint string, ...) error

+ func (s *GSStore) WalkFromTo(ctx context.Context, prefix, startingPoint, exclusiveEndPoint string, ...) error

+ func (s *GSStore) WriteObject(ctx context.Context, base string, f io.Reader, metadataKeyValues ...string) (err error)

+ type GZipReadCloser struct

+ func NewGZipReadCloser(src io.ReadCloser) (*GZipReadCloser, error)

+ func (g *GZipReadCloser) Close() error

+ type LocalStore struct

+ func NewLocalStore(baseURL *url.URL, extension, compressionType string, overwrite bool, ...) (*LocalStore, error)

+ func (c LocalStore) Overwrite() bool

+ func (c LocalStore) SetMeter(meter Meter)

+ func (c LocalStore) SetOverwrite(in bool)

+ func (s *LocalStore) BaseURL() *url.URL

+ func (s *LocalStore) Clone(ctx context.Context, opts ...Option) (Store, error)

+ func (s *LocalStore) CopyObject(ctx context.Context, src, dest string) error

+ func (s *LocalStore) DeleteObject(ctx context.Context, base string) error

+ func (s *LocalStore) FileExists(ctx context.Context, base string) (bool, error)

+ func (s *LocalStore) ListFiles(ctx context.Context, prefix string, max int) ([]string, error)

+ func (s *LocalStore) ObjectAttributes(ctx context.Context, base string) (*ObjectAttributes, error)

+ func (s *LocalStore) ObjectPath(name string) string

+ func (s *LocalStore) ObjectURL(name string) string

+ func (s *LocalStore) OpenObject(ctx context.Context, name string) (out io.ReadCloser, err error)

+ func (s *LocalStore) PushLocalFile(ctx context.Context, localFile, toBaseName string) error

+ func (s *LocalStore) SetMetadata(ctx context.Context, base string, metadata map[string]string) error

+ func (s *LocalStore) SubStore(subFolder string) (Store, error)

+ func (s *LocalStore) Walk(ctx context.Context, prefix string, f func(filename string) (err error)) error

+ func (s *LocalStore) WalkFrom(ctx context.Context, prefix, startingPoint string, ...) error

+ func (s *LocalStore) WalkFromTo(ctx context.Context, prefix, startingPoint, exclusiveEndPoint string, ...) error

+ func (s *LocalStore) WriteObject(ctx context.Context, base string, reader io.Reader, ...) (err error)

+ type MemoryStore struct

+ func NewMemoryStore(baseURL *url.URL, extension, compressionType string, overwrite bool, ...) (*MemoryStore, error)

+ func (c MemoryStore) Overwrite() bool

+ func (c MemoryStore) SetMeter(meter Meter)

+ func (c MemoryStore) SetOverwrite(in bool)

+ func (m *MemoryStore) BaseURL() *url.URL

+ func (m *MemoryStore) Clone(ctx context.Context, opts ...Option) (Store, error)

+ func (m *MemoryStore) CopyObject(_ context.Context, src, dest string) error

+ func (m *MemoryStore) DeleteObject(ctx context.Context, base string) error

+ func (m *MemoryStore) FileExists(_ context.Context, base string) (bool, error)

+ func (m *MemoryStore) ListFiles(ctx context.Context, prefix string, max int) ([]string, error)

+ func (m *MemoryStore) ObjectAttributes(_ context.Context, base string) (*ObjectAttributes, error)

+ func (m *MemoryStore) ObjectPath(name string) string

+ func (m *MemoryStore) ObjectURL(name string) string

+ func (m *MemoryStore) OpenObject(ctx context.Context, name string) (out io.ReadCloser, err error)

+ func (m *MemoryStore) PushLocalFile(ctx context.Context, localFile, toBaseName string) (err error)

+ func (m *MemoryStore) SetMetadata(ctx context.Context, base string, metadata map[string]string) error

+ func (m *MemoryStore) SubStore(subFolder string) (Store, error)

+ func (m *MemoryStore) Walk(ctx context.Context, prefix string, f func(filename string) (err error)) error

+ func (m *MemoryStore) WalkFrom(_ context.Context, prefix, startingPoint string, ...) error

+ func (m *MemoryStore) WalkFromTo(_ context.Context, prefix, startingPoint, exclusiveEndPoint string, ...) error

+ func (m *MemoryStore) WriteObject(ctx context.Context, base string, f io.Reader, metadataKeyValues ...string) (err error)

+ type Meter interface

+ AddBytesRead func(int)

+ AddBytesWritten func(int)

+ type MockStore struct

+ CopyObjectFunc func(ctx context.Context, src, dest string) error

+ DeleteObjectFunc func(ctx context.Context, base string) error

+ FileExistsFunc func(ctx context.Context, base string) (bool, error)

+ Files map[string][]byte

+ ListFilesFunc func(ctx context.Context, prefix string, max int) ([]string, error)

+ Metadata map[string]map[string]string

+ ObjectAttributesFunc func(ctx context.Context, base string) (*ObjectAttributes, error)

+ OpenObjectFunc func(ctx context.Context, name string) (out io.ReadCloser, err error)

+ PushLocalFileFunc func(ctx context.Context, localFile string, toBaseName string) (err error)

+ SetMetadataFunc func(ctx context.Context, base string, metadata map[string]string) error

+ WalkFromFunc func(ctx context.Context, prefix, startingPoint string, ...) error

+ WalkFromToFunc func(ctx context.Context, prefix, startingPoint, exclusiveEndPoint string, ...) error

+ WalkFunc func(ctx context.Context, prefix string, f func(filename string) error) error

+ WriteObjectFunc func(ctx context.Context, base string, f io.Reader, metadataKeyValues ...string) error

+ func NewMockStore(writeFunc func(base string, f io.Reader) (err error)) *MockStore

+ func (_ *MockStore) SetMeter(_ Meter)

+ func (s *MockStore) BaseURL() *url.URL

+ func (s *MockStore) CopyObject(ctx context.Context, src, dest string) error

+ func (s *MockStore) DeleteObject(ctx context.Context, base string) error

+ func (s *MockStore) FileExists(ctx context.Context, base string) (bool, error)

+ func (s *MockStore) ListFiles(ctx context.Context, prefix string, max int) ([]string, error)

+ func (s *MockStore) ObjectAttributes(ctx context.Context, base string) (*ObjectAttributes, error)

+ func (s *MockStore) ObjectPath(base string) string

+ func (s *MockStore) ObjectURL(base string) string

+ func (s *MockStore) OpenObject(ctx context.Context, name string) (out io.ReadCloser, err error)

+ func (s *MockStore) Overwrite() bool

+ func (s *MockStore) PushLocalFile(ctx context.Context, localFile string, toBaseName string) (err error)

+ func (s *MockStore) SetFile(name string, content []byte)

+ func (s *MockStore) SetMetadata(ctx context.Context, base string, metadata map[string]string) error

+ func (s *MockStore) SetOverwrite(in bool)

+ func (s *MockStore) SubStore(subFolder string) (Store, error)

+ func (s *MockStore) Walk(ctx context.Context, prefix string, f func(filename string) error) error

+ func (s *MockStore) WalkFrom(ctx context.Context, prefix, startingPoint string, ...) error

+ func (s *MockStore) WalkFromTo(ctx context.Context, prefix, startingPoint, exclusiveEndPoint string, ...) error

+ func (s *MockStore) WriteFiles(toDirectory string) error

+ func (s *MockStore) WriteObject(ctx context.Context, base string, f io.Reader, metadataKeyValues ...string) (err error)

+ type ObjectAttributes struct

+ LastModified time.Time

+ Metadata map[string]string

+ Size int64

+ type Option interface

+ func AllowOverwrite() Option

+ func Compression(compressionType string) Option

+ func WithCompressedReadCallback(cb func(context.Context, int)) Option

+ func WithCompressedWriteCallback(cb func(context.Context, int)) Option

+ func WithUncompressedReadCallback(cb func(context.Context, int)) Option

+ func WithUncompressedWriteCallback(cb func(context.Context, int)) Option

+ type S3Store struct

+ func NewS3Store(baseURL *url.URL, extension, compressionType string, overwrite bool, ...) (*S3Store, error)

+ func (c S3Store) Overwrite() bool

+ func (c S3Store) SetMeter(meter Meter)

+ func (c S3Store) SetOverwrite(in bool)

+ func (s *S3Store) BaseURL() *url.URL

+ func (s *S3Store) Clone(ctx context.Context, opts ...Option) (Store, error)

+ func (s *S3Store) CopyObject(ctx context.Context, src, dest string) error

+ func (s *S3Store) DeleteObject(ctx context.Context, base string) error

+ func (s *S3Store) FileExists(ctx context.Context, base string) (bool, error)

+ func (s *S3Store) ListFiles(ctx context.Context, prefix string, max int) ([]string, error)

+ func (s *S3Store) ObjectAttributes(ctx context.Context, base string) (*ObjectAttributes, error)

+ func (s *S3Store) ObjectPath(name string) string

+ func (s *S3Store) ObjectURL(name string) string

+ func (s *S3Store) OpenObject(ctx context.Context, name string) (out io.ReadCloser, err error)

+ func (s *S3Store) PushLocalFile(ctx context.Context, localFile, toBaseName string) error

+ func (s *S3Store) SetMetadata(ctx context.Context, base string, metadata map[string]string) error

+ func (s *S3Store) SubStore(subFolder string) (Store, error)

+ func (s *S3Store) Walk(ctx context.Context, prefix string, f func(filename string) (err error)) error

+ func (s *S3Store) WalkFrom(ctx context.Context, prefix, startingPoint string, ...) error

+ func (s *S3Store) WalkFromTo(ctx context.Context, prefix, startingPoint, exclusiveEndPoint string, ...) error

+ func (s *S3Store) WriteObject(ctx context.Context, base string, f io.Reader, metadataKeyValues ...string) (err error)

+ type Store interface

+ BaseURL func() *url.URL

+ CopyObject func(ctx context.Context, src, dest string) error

+ DeleteObject func(ctx context.Context, base string) error

+ FileExists func(ctx context.Context, base string) (bool, error)

+ ListFiles func(ctx context.Context, prefix string, max int) ([]string, error)

+ ObjectAttributes func(ctx context.Context, base string) (*ObjectAttributes, error)

+ ObjectPath func(base string) string

+ ObjectURL func(base string) string

+ OpenObject func(ctx context.Context, name string) (out io.ReadCloser, err error)

+ Overwrite func() bool

+ PushLocalFile func(ctx context.Context, localFile, toBaseName string) (err error)

+ SetMetadata func(ctx context.Context, base string, metadata map[string]string) error

+ SetMeter func(meter Meter)

+ SetOverwrite func(enabled bool)

+ SubStore func(subFolder string) (Store, error)

+ Walk func(ctx context.Context, prefix string, f func(filename string) (err error)) error

+ WalkFrom func(ctx context.Context, prefix, inclusiveFrom string, ...) error

+ WalkFromTo func(ctx context.Context, prefix, inclusiveFrom, exclusiveTo string, ...) error

+ WriteObject func(ctx context.Context, base string, f io.Reader, metadataKeyValues ...string) (err error)

+ func NewDBinStore(baseURL string, opts ...Option) (Store, error)

+ func NewJSONLStore(baseURL string, opts ...Option) (Store, error)

+ func NewSimpleStore(baseURL string, opts ...Option) (Store, error)

+ func NewStore(baseURL, extension, compressionType string, overwrite bool, opts ...Option) (Store, error)

+ func NewStoreFromFileURL(fileURL string, opts ...Option) (store Store, filename string, err error)

+ func OpenObject(ctx context.Context, fileURL string, opts ...Option) (out io.ReadCloser, store Store, filename string, err error)