README
¶
gas/storage
Part of the Gas monorepo · Documentation · All modules
Object storage for the Gas framework, on AWS S3 and S3-compatible services such as MinIO, LocalStack, and DigitalOcean Spaces.
Implements gas.StorageProvider.
go get github.com/gasmod/gas/storage
gas.WithSingletonService[gas.StorageProvider](s3.New()),
s3.New() needs gas.ConfigProvider and gas.Logger.
| Package | Provides |
|---|---|
storage/s3 |
AWS S3 and any S3-compatible object store |
storage/storagetest |
Recording mock of gas.StorageProvider |
Documentation
The full guide, with configuration, testing, and worked examples, is on the docs site. This README is deliberately a signpost: keeping a second copy here is how the docs drifted before.
- Guide: Store and serve files
- API reference: pkg.go.dev/github.com/gasmod/gas/storage
- Contributing: CONTRIBUTING.md
License
Documentation
¶
Overview ¶
Package storage provides object storage for the Gas ecosystem with AWS S3 (and S3-compatible MinIO/LocalStack) backends. Concrete implementations live in the s3 sub-package.
See the module README for usage examples and design rationale.
SPDX-License-Identifier: MIT
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrKeyNotFound is returned by Download or Head when the // requested key does not exist. ErrKeyNotFound = errors.New("storage: key not found") // ErrClosed is returned when an operation is attempted on a closed // storage service. ErrClosed = errors.New("storage: service is closed") // ErrBucketRequired is returned when an operation is invoked without a // bucket configured on the service and without gas.InBucket() supplied // in the call options. ErrBucketRequired = errors.New("storage: bucket required (set Storage.Bucket or pass gas.InBucket())") )
Sentinel errors returned by StorageProvider implementations.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package storagetest provides a mock implementation of gas.StorageProvider for use in tests.
|
Package storagetest provides a mock implementation of gas.StorageProvider for use in tests. |