s3io

Documentation

Index

• Variables
• func Exists(ctx context.Context, path string, client s3iface.S3API) (bool, error)
• func IsS3Path(path string) bool
• func NewClient(cfg *aws.Config) *s3.S3
• func ReadFile(ctx context.Context, path string, client s3iface.S3API) ([]byte, error)
• func Remove(ctx context.Context, path string, client s3iface.S3API) error
• func RemoveAll(ctx context.Context, path string, client s3iface.S3API) error
• type Info
  • func List(ctx context.Context, path string, client s3iface.S3API) ([]Info, error)
  • func Stat(ctx context.Context, uri string, client s3iface.S3API) (Info, error)
• type Reader
  • func NewReader(ctx context.Context, path string, client s3iface.S3API) (*Reader, error)
  • func (r *Reader) Close() error
  • func (r *Reader) Read(p []byte) (int, error)
  • func (r *Reader) ReadAt(p []byte, off int64) (int, error)
  • func (r *Reader) Seek(offset int64, whence int) (int64, error)
  • func (r *Reader) Size() (int64, error)
• type Replacer
  • func NewReplacer(ctx context.Context, path string, client s3iface.S3API, ...) (*Replacer, error)
  • func (r *Replacer) Abort()
  • func (r *Replacer) Close() error
• type Writer
  • func NewWriter(ctx context.Context, path string, client s3iface.S3API, ...) (*Writer, error)
  • func (w *Writer) Close() error
  • func (w *Writer) Write(b []byte) (int, error)

Variables

var ErrInvalidS3Path = errors.New("path is not a valid s3 location")

Functions

func Exists

func Exists(ctx context.Context, path string, client s3iface.S3API) (bool, error)

func IsS3Path

func IsS3Path(path string) bool

func NewClient

func NewClient(cfg *aws.Config) *s3.S3

func ReadFile

func ReadFile(ctx context.Context, path string, client s3iface.S3API) ([]byte, error)

func Remove

func Remove(ctx context.Context, path string, client s3iface.S3API) error

func RemoveAll

func RemoveAll(ctx context.Context, path string, client s3iface.S3API) error

Types

type Info

type Info struct {
	Name    string
	Size    int64
	ModTime time.Time
	IsDir   bool
}

func List

func List(ctx context.Context, path string, client s3iface.S3API) ([]Info, error)

func Stat

func Stat(ctx context.Context, uri string, client s3iface.S3API) (Info, error)

type Reader

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

func NewReader

func NewReader(ctx context.Context, path string, client s3iface.S3API) (*Reader, error)

func (*Reader) Close

func (r *Reader) Close() error

func (*Reader) Read

func (r *Reader) Read(p []byte) (int, error)

func (*Reader) ReadAt

func (r *Reader) ReadAt(p []byte, off int64) (int, error)

func (*Reader) Seek

func (r *Reader) Seek(offset int64, whence int) (int64, error)

func (*Reader) Size

func (r *Reader) Size() (int64, error)

type Replacer

type Replacer struct {
	*Writer
}

func NewReplacer

func NewReplacer(ctx context.Context, path string, client s3iface.S3API, options ...func(*s3manager.Uploader)) (*Replacer, error)

func (*Replacer) Abort

func (r *Replacer) Abort()

func (*Replacer) Close

func (r *Replacer) Close() error

type Writer

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

func NewWriter

func NewWriter(ctx context.Context, path string, client s3iface.S3API, options ...func(*s3manager.Uploader)) (*Writer, error)

func (*Writer) Close

func (w *Writer) Close() error

func (*Writer) Write

func (w *Writer) Write(b []byte) (int, error)