disk

Documentation

Index

• type Client
• type Common
  • func NewCommon(disk fs.Disk) *Common
  • func (c *Common) AllDirectories(dir string) []fs.Disk
  • func (c *Common) AllFiles(dir string) []*fs.File
  • func (c *Common) Append(file string, content []byte) error
  • func (c *Common) Copy(source string, destination string) error
  • func (c *Common) File(file string) *fs.File
  • func (c *Common) LastModified(file string) int64
  • func (c *Common) Missing(file string) bool
  • func (c *Common) Move(source string, destination string) error
  • func (c *Common) Prepend(file string, content []byte) error
  • func (c *Common) Size(file string) int64
• type Local
  • func NewLocal(config LocalConfig) *Local
  • func (l *Local) Attributes(file string) fs.Attributes
  • func (l *Local) Cwd() string
  • func (l *Local) Delete(files ...string) error
  • func (l *Local) DeleteDirectory(dir string) error
  • func (l *Local) Directories(dir string) []fs.Disk
  • func (l *Local) Exists(file string) bool
  • func (l *Local) Files(dir string) []*fs.File
  • func (l *Local) Get(file string) ([]byte, error)
  • func (l *Local) MakeDirectory(dir string, visibility fs.Visibility) error
  • func (l *Local) Path(file string) string
  • func (l *Local) Prefix(prefix string) fs.Disk
  • func (l *Local) Put(file string, content []byte, visibility fs.Visibility) error
• type LocalConfig
• type Memory
  • func NewMemory(config MemoryConfig) *Memory
  • func (m *Memory) Prefix(prefix string) fs.Disk
• type MemoryClient
  • func NewMemoryClient() *MemoryClient
  • func (m *MemoryClient) DeleteObject(ctx context.Context, params *s3.DeleteObjectInput, optFns ...func(*s3.Options)) (*s3.DeleteObjectOutput, error)
  • func (m *MemoryClient) GetObject(ctx context.Context, params *s3.GetObjectInput, optFns ...func(*s3.Options)) (*s3.GetObjectOutput, error)
  • func (m *MemoryClient) GetObjectAttributes(ctx context.Context, params *s3.GetObjectAttributesInput, ...) (*s3.GetObjectAttributesOutput, error)
  • func (m *MemoryClient) HeadObject(ctx context.Context, params *s3.HeadObjectInput, optFns ...func(*s3.Options)) (*s3.HeadObjectOutput, error)
  • func (m *MemoryClient) ListObjects(ctx context.Context, params *s3.ListObjectsInput, optFns ...func(*s3.Options)) (*s3.ListObjectsOutput, error)
  • func (m *MemoryClient) PutObject(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error)
• type MemoryConfig
• type S3
  • func NewS3(config S3Config) *S3
  • func (s *S3) Attributes(file string) fs.Attributes
  • func (s *S3) Cwd() string
  • func (s *S3) Delete(files ...string) error
  • func (s *S3) DeleteDirectory(dir string) error
  • func (s *S3) Directories(dir string) []fs.Disk
  • func (s *S3) Exists(file string) bool
  • func (s *S3) Files(dir string) []*fs.File
  • func (s *S3) Get(file string) ([]byte, error)
  • func (s *S3) MakeDirectory(dir string, visibility fs.Visibility) error
  • func (s *S3) Options() *s3.Options
  • func (s *S3) Path(file string) string
  • func (s *S3) Prefix(prefix string) fs.Disk
  • func (s *S3) Put(file string, content []byte, visibility fs.Visibility) error
• type S3Config

Types

type Client

type Client interface {
	PutObject(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error)
	GetObject(ctx context.Context, params *s3.GetObjectInput, optFns ...func(*s3.Options)) (*s3.GetObjectOutput, error)
	GetObjectAttributes(ctx context.Context, params *s3.GetObjectAttributesInput, optFns ...func(*s3.Options)) (*s3.GetObjectAttributesOutput, error)
	HeadObject(ctx context.Context, params *s3.HeadObjectInput, optFns ...func(*s3.Options)) (*s3.HeadObjectOutput, error)
	DeleteObject(ctx context.Context, params *s3.DeleteObjectInput, optFns ...func(*s3.Options)) (*s3.DeleteObjectOutput, error)
	ListObjects(ctx context.Context, params *s3.ListObjectsInput, optFns ...func(*s3.Options)) (*s3.ListObjectsOutput, error)
}

type Common

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

func NewCommon

func NewCommon(disk fs.Disk) *Common

func (*Common) AllDirectories

func (c *Common) AllDirectories(dir string) []fs.Disk

func (*Common) AllFiles

func (c *Common) AllFiles(dir string) []*fs.File

func (*Common) Append

func (c *Common) Append(file string, content []byte) error

func (*Common) Copy

func (c *Common) Copy(source string, destination string) error

func (*Common) File

func (c *Common) File(file string) *fs.File

func (*Common) LastModified

func (c *Common) LastModified(file string) int64

func (*Common) Missing

func (c *Common) Missing(file string) bool

func (*Common) Move

func (c *Common) Move(source string, destination string) error

func (*Common) Prepend

func (c *Common) Prepend(file string, content []byte) error

func (*Common) Size

func (c *Common) Size(file string) int64

type Local

type Local struct {
	*Common
	// contains filtered or unexported fields
}

func NewLocal

func NewLocal(config LocalConfig) *Local

func (*Local) Attributes

func (l *Local) Attributes(file string) fs.Attributes

func (*Local) Cwd

func (l *Local) Cwd() string

func (*Local) Delete

func (l *Local) Delete(files ...string) error

func (*Local) DeleteDirectory

func (l *Local) DeleteDirectory(dir string) error

func (*Local) Directories

func (l *Local) Directories(dir string) []fs.Disk

func (*Local) Exists

func (l *Local) Exists(file string) bool

func (*Local) Files

func (l *Local) Files(dir string) []*fs.File

func (*Local) Get

func (l *Local) Get(file string) ([]byte, error)

func (*Local) MakeDirectory

func (l *Local) MakeDirectory(dir string, visibility fs.Visibility) error

func (*Local) Path

func (l *Local) Path(file string) string

func (*Local) Prefix

func (l *Local) Prefix(prefix string) fs.Disk

func (*Local) Put

func (l *Local) Put(file string, content []byte, visibility fs.Visibility) error

type LocalConfig

type LocalConfig struct {
	PermModeFilePublic       os.FileMode
	PermModeFilePrivate      os.FileMode
	PermModeDirectoryPublic  os.FileMode
	PermModeDirectoryPrivate os.FileMode
	Prefix                   string
}

type Memory

type Memory struct {
	*S3
	// contains filtered or unexported fields
}

func NewMemory

func NewMemory(config MemoryConfig) *Memory

func (*Memory) Prefix

func (m *Memory) Prefix(prefix string) fs.Disk

type MemoryClient

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

func NewMemoryClient

func NewMemoryClient() *MemoryClient

func (*MemoryClient) DeleteObject

func (m *MemoryClient) DeleteObject(ctx context.Context, params *s3.DeleteObjectInput, optFns ...func(*s3.Options)) (*s3.DeleteObjectOutput, error)

func (*MemoryClient) GetObject

func (m *MemoryClient) GetObject(ctx context.Context, params *s3.GetObjectInput, optFns ...func(*s3.Options)) (*s3.GetObjectOutput, error)

func (*MemoryClient) GetObjectAttributes

func (m *MemoryClient) GetObjectAttributes(ctx context.Context, params *s3.GetObjectAttributesInput, optFns ...func(*s3.Options)) (*s3.GetObjectAttributesOutput, error)

func (*MemoryClient) HeadObject

func (m *MemoryClient) HeadObject(ctx context.Context, params *s3.HeadObjectInput, optFns ...func(*s3.Options)) (*s3.HeadObjectOutput, error)

func (*MemoryClient) ListObjects

func (m *MemoryClient) ListObjects(ctx context.Context, params *s3.ListObjectsInput, optFns ...func(*s3.Options)) (*s3.ListObjectsOutput, error)

func (*MemoryClient) PutObject

func (m *MemoryClient) PutObject(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error)

type MemoryConfig

type MemoryConfig struct {
	Prefix string
}

type S3

type S3 struct {
	*Common
	// contains filtered or unexported fields
}

func NewS3

func NewS3(config S3Config) *S3

func (*S3) Attributes

func (s *S3) Attributes(file string) fs.Attributes

func (*S3) Cwd

func (s *S3) Cwd() string

func (*S3) Delete

func (s *S3) Delete(files ...string) error

func (*S3) DeleteDirectory

func (s *S3) DeleteDirectory(dir string) error

func (*S3) Directories

func (s *S3) Directories(dir string) []fs.Disk

func (*S3) Exists

func (s *S3) Exists(file string) bool

func (*S3) Files

func (s *S3) Files(dir string) []*fs.File

func (*S3) Get

func (s *S3) Get(file string) ([]byte, error)

func (*S3) MakeDirectory

func (s *S3) MakeDirectory(dir string, visibility fs.Visibility) error

func (*S3) Options

func (s *S3) Options() *s3.Options

func (*S3) Path

func (s *S3) Path(file string) string

func (*S3) Prefix

func (s *S3) Prefix(prefix string) fs.Disk

func (*S3) Put

func (s *S3) Put(file string, content []byte, visibility fs.Visibility) error

type S3Config

type S3Config struct {
	Client           Client
	OptionsFuncs     []func(*s3.Options)
	Credentials      aws.CredentialsProvider
	Key              string
	Secret           string
	Bucket           string
	Endpoint         string
	EndpointResolver s3.EndpointResolver
	Prefix           string
}