storage

package

Go to main page

Versions in this module

v1

v1.1.2

Aug 14, 2026

Changes in this version

+ const MaxIndexedObjects

+ var ErrIndexedObjectLimitExceeded = errors.New("indexed storage object count exceeds supported limit")

type Adapter

+ CreateRangedDownloadStream func(ctx context.Context, objectName string, offset, count int64) (io.ReadCloser, error)

+ InspectFolderSummary func(ctx context.Context, folderName string) (FolderSummary, error)

+ InspectIndexedFolder func(ctx context.Context, folderName string, expectedObjects int) (int64, error)

+ InspectIndexedFolderSizes func(ctx context.Context, folderName string, expectedObjects int) ([]int64, error)

+ WalkTopLevelFolders func(ctx context.Context, visit func(folderName string) error) error

type FilesystemAdapter

+ func (a *FilesystemAdapter) CreateRangedDownloadStream(ctx context.Context, objectName string, offset, count int64) (io.ReadCloser, error)

+ func (a *FilesystemAdapter) InspectFolderSummary(ctx context.Context, folderName string) (FolderSummary, error)

+ func (a *FilesystemAdapter) InspectIndexedFolder(ctx context.Context, folderName string, expectedObjects int) (int64, error)

+ func (a *FilesystemAdapter) InspectIndexedFolderSizes(ctx context.Context, folderName string, expectedObjects int) ([]int64, error)

+ func (a *FilesystemAdapter) WalkTemporaryUploads(ctx context.Context, visit func(ObjectMetadata) error) error

+ func (a *FilesystemAdapter) WalkTopLevelFolders(ctx context.Context, visit func(folderName string) error) error

+ type FolderSummary struct

+ Exists bool

+ FolderName string

+ NewestModifiedAt time.Time

+ ObjectCount int64

+ PhysicalBytes int64

+ type IndexedObjectLimitExceededError struct

+ Count int

+ Limit int

+ func (e IndexedObjectLimitExceededError) Error() string

+ func (e IndexedObjectLimitExceededError) Unwrap() error

type S3Adapter

+ func (a *S3Adapter) CreateRangedDownloadStream(ctx context.Context, objectName string, offset, count int64) (io.ReadCloser, error)

+ func (a *S3Adapter) InspectFolderSummary(ctx context.Context, folderName string) (FolderSummary, error)

+ func (a *S3Adapter) InspectIndexedFolder(ctx context.Context, folderName string, expectedObjects int) (int64, error)

+ func (a *S3Adapter) InspectIndexedFolderSizes(ctx context.Context, folderName string, expectedObjects int) ([]int64, error)

+ func (a *S3Adapter) WalkTopLevelFolders(ctx context.Context, visit func(folderName string) error) error

type TemporaryUploadCleaner

+ WalkTemporaryUploads func(ctx context.Context, visit func(ObjectMetadata) error) error

v1.1.1

Jul 30, 2026

Changes in this version

+ var ErrIndexedObjectMissing = errors.New("indexed storage object is missing")

+ func MergedObject(folderName string) string

+ func PartsFolder(folderName string) string

type Adapter

+ InspectFolder func(ctx context.Context, folderName string) (FolderContents, error)

+ InspectObject func(ctx context.Context, objectName string) (ObjectMetadata, error)

+ Inventory func(ctx context.Context) (Inventory, error)

+ ObjectExists func(ctx context.Context, objectName string) (bool, error)

type FilesystemAdapter

+ func (a *FilesystemAdapter) CleanupTemporaryUploads(ctx context.Context, candidates []ObjectMetadata, cutoff time.Time) (int, error)

+ func (a *FilesystemAdapter) FilesystemUsage(ctx context.Context) (FilesystemUsage, error)

+ func (a *FilesystemAdapter) InspectFolder(ctx context.Context, folderName string) (FolderContents, error)

+ func (a *FilesystemAdapter) InspectObject(ctx context.Context, objectName string) (ObjectMetadata, error)

+ func (a *FilesystemAdapter) Inventory(ctx context.Context) (Inventory, error)

+ func (a *FilesystemAdapter) ObjectExists(ctx context.Context, objectName string) (bool, error)

+ type FilesystemUsage struct

+ CapacityBytes int64

+ UsedBytes int64

+ type FilesystemUsageAdapter interface

+ FilesystemUsage func(ctx context.Context) (FilesystemUsage, error)

+ type FolderContents struct

+ Exists bool

+ FolderName string

+ NewestModifiedAt time.Time

+ ObjectCount int64

+ Objects []ObjectMetadata

+ PhysicalBytes int64

+ func (f FolderContents) LogicalIndexedSize(partCount int) (int64, error)

+ type FolderInventory struct

+ Blocks ObjectSummary

+ FolderName string

+ Merged *ObjectMetadata

+ NewestModifiedAt time.Time

+ ObjectCount int64

+ Parts []PartObject

+ PhysicalBytes int64

+ Unknown ObjectSummary

+ func (f FolderInventory) LogicalPartsSize(partCount int) (int64, error)

+ type IndexedObjectMissingError struct

+ Index int

+ func (e IndexedObjectMissingError) Error() string

+ func (e IndexedObjectMissingError) Unwrap() error

+ type Inventory struct

+ Folders []FolderInventory

+ LooseObjects []ObjectMetadata

+ NewestModifiedAt time.Time

+ ObjectCount int64

+ PhysicalBytes int64

+ TemporaryUploads []ObjectMetadata

+ func (i Inventory) Folder(folderName string) (FolderInventory, bool)

+ type ObjectMetadata struct

+ ModifiedAt time.Time

+ Name string

+ SizeBytes int64

+ type ObjectSummary struct

+ NewestModifiedAt time.Time

+ ObjectCount int64

+ PhysicalBytes int64

+ type PartObject struct

+ Index int

+ ModifiedAt time.Time

+ SizeBytes int64

type S3Adapter

+ func (a *S3Adapter) InspectFolder(ctx context.Context, folderName string) (FolderContents, error)

+ func (a *S3Adapter) InspectObject(ctx context.Context, objectName string) (ObjectMetadata, error)

+ func (a *S3Adapter) Inventory(ctx context.Context) (Inventory, error)

+ func (a *S3Adapter) ObjectExists(ctx context.Context, objectName string) (bool, error)

+ type TemporaryUploadCleaner interface

+ CleanupTemporaryUploads func(ctx context.Context, candidates []ObjectMetadata, cutoff time.Time) (int, error)

v1.0.6

Jul 27, 2026

Changes in this version

+ var ErrComposeUnsupported = errors.New("object sequence cannot be composed by this storage backend")

type Adapter

+ CopyObject func(ctx context.Context, sourceObjectName, destinationObjectName string) error

+ type ComposeAdapter interface

+ ComposeObjects func(ctx context.Context, destinationObjectName string, sourceObjectNames []string) error

type FilesystemAdapter

+ func (a *FilesystemAdapter) CopyObject(ctx context.Context, sourceObjectName, destinationObjectName string) error

type S3Adapter

+ func (a *S3Adapter) ComposeObjects(ctx context.Context, destinationObjectName string, sourceObjectNames []string) error

+ func (a *S3Adapter) CopyObject(ctx context.Context, sourceObjectName, destinationObjectName string) error

v1.0.5

May 27, 2026

v1.0.4

May 26, 2026

v1.0.3

May 25, 2026

v1.0.2

May 25, 2026

v1.0.1

May 25, 2026

Changes in this version

+ const DriverFilesystem

+ const DriverS3

+ var ErrObjectNotFound = errors.New("object not found in storage")

+ type Adapter interface

+ Clear func(ctx context.Context) error

+ CountFilesInFolder func(ctx context.Context, folderName string) (int, error)

+ CreateDownloadStream func(ctx context.Context, objectName string) (io.ReadCloser, error)

+ DeleteFolder func(ctx context.Context, folderName string) error

+ UploadStream func(ctx context.Context, objectName string, stream io.Reader) error

+ func NewAdapter(ctx context.Context, cfg config.StorageConfig) (Adapter, error)

+ type DirectDownloadAdapter interface

+ CreateDownloadURL func(ctx context.Context, objectName string, ttl time.Duration) (string, error)

+ type FilesystemAdapter struct

+ func NewFilesystemAdapter(root string) (*FilesystemAdapter, error)

+ func (a *FilesystemAdapter) Clear(_ context.Context) error

+ func (a *FilesystemAdapter) CountFilesInFolder(_ context.Context, folderName string) (int, error)

+ func (a *FilesystemAdapter) CreateDownloadStream(_ context.Context, objectName string) (io.ReadCloser, error)

+ func (a *FilesystemAdapter) DeleteFolder(_ context.Context, folderName string) error

+ func (a *FilesystemAdapter) UploadStream(ctx context.Context, objectName string, stream io.Reader) error

+ type ObjectNotFoundError struct

+ ObjectName string

+ func (e ObjectNotFoundError) Error() string

+ func (e ObjectNotFoundError) Unwrap() error

+ type S3Adapter struct

+ func NewS3Adapter(ctx context.Context, cfg config.StorageConfig) (*S3Adapter, error)

+ func (a *S3Adapter) Clear(ctx context.Context) error

+ func (a *S3Adapter) CountFilesInFolder(ctx context.Context, folderName string) (int, error)

+ func (a *S3Adapter) CreateDownloadStream(ctx context.Context, objectName string) (io.ReadCloser, error)

+ func (a *S3Adapter) CreateDownloadURL(ctx context.Context, objectName string, ttl time.Duration) (string, error)

+ func (a *S3Adapter) DeleteFolder(ctx context.Context, folderName string) error

+ func (a *S3Adapter) UploadStream(ctx context.Context, objectName string, stream io.Reader) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL