disk

Documentation

Overview

Package disk is the local disk storage provider for objects service

Index

• Constants
• Variables
• func NewDiskProviderFromCredentials(credentials storage.ProviderCredentials) mo.Result[storagetypes.Provider]
• type Builder
  • func NewDiskBuilder() *Builder
  • func (b *Builder) Build(_ context.Context, _ storage.ProviderCredentials, ...) (storagetypes.Provider, error)
  • func (b *Builder) ProviderType() string
• type Provider
  • func NewDiskProvider(options *storage.ProviderOptions) (*Provider, error)
  • func (p *Provider) Close() error
  • func (p *Provider) Delete(_ context.Context, file *storagetypes.File, _ *storagetypes.DeleteFileOptions) error
  • func (p *Provider) Download(_ context.Context, file *storagetypes.File, ...) (*storagetypes.DownloadedFileMetadata, error)
  • func (p *Provider) Exists(_ context.Context, file *storagetypes.File) (bool, error)
  • func (p *Provider) GetPresignedURL(ctx context.Context, file *storagetypes.File, ...) (string, error)
  • func (p *Provider) GetScheme() *string
  • func (p *Provider) ListBuckets() ([]string, error)
  • func (p *Provider) ProviderType() storagetypes.ProviderType
  • func (p *Provider) Upload(_ context.Context, reader io.Reader, opts *storagetypes.UploadFileOptions) (*storagetypes.UploadedFileMetadata, error)

Constants

const (
	// DefaultDirPermissions defines the default permissions for created directories
	DefaultDirPermissions = 0755
	// DefaultFilePermissions defines the default permissions for created files
	DefaultFilePermissions = 0644
)

Variables

var (
	// ErrDiskCheckExists is returned when file existence check fails
	ErrDiskCheckExists = errors.New("failed to check if file exists")
	// ErrInvalidFolderPath is returned when an invalid folder path is provided
	ErrInvalidFolderPath = errors.New("invalid folder path provided")
	// ErrMissingLocalURL is returned when no local URL is configured for presigned links
	ErrMissingLocalURL = errors.New("missing local URL in disk storage options")
)

Functions

func NewDiskProviderFromCredentials

func NewDiskProviderFromCredentials(credentials storage.ProviderCredentials) mo.Result[storagetypes.Provider]

NewDiskProviderFromCredentials creates a disk provider from credential struct

Types

type Builder

type Builder struct{}

Builder creates disk providers for the client pool

func NewDiskBuilder

func NewDiskBuilder() *Builder

NewDiskBuilder creates a new Builder

func (*Builder) Build

func (b *Builder) Build(_ context.Context, _ storage.ProviderCredentials, config *storage.ProviderOptions) (storagetypes.Provider, error)

Build implements eddy.Builder

func (*Builder) ProviderType

func (b *Builder) ProviderType() string

ProviderType implements eddy.Builder

type Provider

type Provider struct {
	Scheme string
	// contains filtered or unexported fields
}

Provider implements the storagetypes.Provider interface for local filesystem storage

func NewDiskProvider

func NewDiskProvider(options *storage.ProviderOptions) (*Provider, error)

NewDiskProvider creates a new disk provider instance

func (*Provider) Close

func (p *Provider) Close() error

Close cleans up resources

func (*Provider) Delete

func (p *Provider) Delete(_ context.Context, file *storagetypes.File, _ *storagetypes.DeleteFileOptions) error

Delete implements storagetypes.Provider

func (*Provider) Download

func (p *Provider) Download(_ context.Context, file *storagetypes.File, _ *storagetypes.DownloadFileOptions) (*storagetypes.DownloadedFileMetadata, error)

Download implements storagetypes.Provider

func (*Provider) Exists

func (p *Provider) Exists(_ context.Context, file *storagetypes.File) (bool, error)

Exists checks if a file exists on disk

func (*Provider) GetPresignedURL

func (p *Provider) GetPresignedURL(ctx context.Context, file *storagetypes.File, opts *storagetypes.PresignedURLOptions) (string, error)

GetPresignedURL implements storagetypes.Provider

func (*Provider) GetScheme

func (p *Provider) GetScheme() *string

GetScheme returns the URI scheme for disk

func (*Provider) ListBuckets

func (p *Provider) ListBuckets() ([]string, error)

ListBuckets lists the local bucket if it exists

func (*Provider) ProviderType

func (p *Provider) ProviderType() storagetypes.ProviderType

func (*Provider) Upload

func (p *Provider) Upload(_ context.Context, reader io.Reader, opts *storagetypes.UploadFileOptions) (*storagetypes.UploadedFileMetadata, error)

Upload implements storagetypes.Provider