storage

package

v0.9.3 Latest Latest Go to latest Published: Mar 5, 2026 License: BSD-3-Clause-LBNL Imports: 20 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/esnet/gdg

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func NewCloudStorage(c context.Context, encoder ports.CipherEncoder) (ports.Storage, error)
func NewLocalStorage(ctx context.Context) ports.Storage
func NewStorageFromConfig(storageType string, appData map[string]string, encoder ports.CipherEncoder) (ports.Storage, error)
type CloudStorage
type ContextStorage
type LocalStorage
type Resolver
- func (r *Resolver) ResolveEndpoint(ctx context.Context, params s3.EndpointParameters) (transport.Endpoint, error)
type Type
- func (t Type) String() string

Constants ¶

View Source

const (
	Context = ContextStorage("storage")
	// Cloud Specific const
	CloudType             = "cloud_type"
	BucketName            = "bucket_name"
	Prefix                = "prefix"
	Custom                = "custom"
	AccessId              = "access_id"
	SecretKey             = "secret_key"
	Endpoint              = "endpoint"
	Region                = "region"
	InitBucket            = "init_bucket"
	LocalStorageType Type = "LocalStorage"
	SecureLocation        = "secure_location"
	// Auth
	CloudKey    = "AWS_ACCESS_KEY" // #nosec G101
	CloudSecret = "AWS_SECRET_KEY" // #nosec G101
)

Variables ¶

This section is empty.

Functions ¶

func NewCloudStorage ¶

func NewCloudStorage(c context.Context, encoder ports.CipherEncoder) (ports.Storage, error)

NewCloudStorage creates a CloudStorage instance using context‑provided config. It validates context, parses app data, supports custom S3 endpoints or native cloud URLs, initializes the bucket (creating it if requested), and returns a configured Storage.

func NewLocalStorage ¶

func NewLocalStorage(ctx context.Context) ports.Storage

func NewStorageFromConfig ¶

func NewStorageFromConfig(storageType string, appData map[string]string, encoder ports.CipherEncoder) (ports.Storage, error)

Types ¶

type CloudStorage ¶

type CloudStorage struct {
	BucketRef   *blob.Bucket
	BucketName  string
	Prefix      string
	StorageName string
}

func (*CloudStorage) FindAllFiles ¶

func (s *CloudStorage) FindAllFiles(folder string, fullPath bool) ([]string, error)

func (*CloudStorage) GetPrefix ¶

func (s *CloudStorage) GetPrefix() string

func (*CloudStorage) Name ¶

func (s *CloudStorage) Name() string

func (*CloudStorage) ReadFile ¶

func (s *CloudStorage) ReadFile(filename string) ([]byte, error)

ReadFile read file from Cloud Provider and return byte array

func (*CloudStorage) WriteFile ¶

func (s *CloudStorage) WriteFile(filename string, data []byte) error

WriteFile persists data to Cloud Provider Storage returning error if operation failed

type ContextStorage ¶

type ContextStorage string

type LocalStorage ¶

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

LocalStorage default storage engine

func (*LocalStorage) FindAllFiles ¶

func (s *LocalStorage) FindAllFiles(folder string, fullPath bool) ([]string, error)

func (*LocalStorage) GetPrefix ¶

func (s *LocalStorage) GetPrefix() string

GetPrefix should always return "" for local storage

func (*LocalStorage) Name ¶

func (s *LocalStorage) Name() string

func (*LocalStorage) ReadFile ¶

func (s *LocalStorage) ReadFile(filename string) ([]byte, error)

ReadFile returns a byte array of file content

func (*LocalStorage) WriteFile ¶

func (s *LocalStorage) WriteFile(filename string, data []byte) error

WriteFile writes file to disk and returns an error if operation failed

type Resolver ¶

type Resolver struct {
	URL *url.URL
}

AWS Crud

func (*Resolver) ResolveEndpoint ¶

func (r *Resolver) ResolveEndpoint(ctx context.Context, params s3.EndpointParameters) (transport.Endpoint, error)

type Type ¶

type Type string

func (Type) String ¶

func (t Type) String() string

Source Files ¶

View all Source files

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