fileutil

Documentation

Index

• func Copy(ctx context.Context, dst io.Writer, src io.Reader, opts ...FileOption) error
• func CopyFile(ctx context.Context, dstFile, srcFile string, opts ...FileOption) error
• func CopyReader(ctx context.Context, dstFile string, src io.Reader, opts ...FileOption) error
• func CopyWriter(ctx context.Context, dst io.Writer, srcFile string, opts ...FileOption) error
• func Create(ctx context.Context, file string, opts ...FileOption) (io.WriteCloser, error)
• func Open(ctx context.Context, file string, opts ...FileOption) (io.ReadCloser, error)
• func Stat(ctx context.Context, file string, opts ...FileOption) (os.FileInfo, error)
• type CopyProgress
• type FileOption
  • func WithContext(ctx context.Context) FileOption
  • func WithEnvs(envs map[string]string) FileOption
  • func WithProgress(totalSize int64, progress CopyProgress) FileOption
• type FileOptions
• type FileUtil

Functions

func Copy

func Copy(ctx context.Context, dst io.Writer, src io.Reader, opts ...FileOption) error

Copy ..

func CopyFile

func CopyFile(ctx context.Context, dstFile, srcFile string, opts ...FileOption) error

CopyFile ..

func CopyReader

func CopyReader(ctx context.Context, dstFile string, src io.Reader, opts ...FileOption) error

CopyReader ..

func CopyWriter

func CopyWriter(ctx context.Context, dst io.Writer, srcFile string, opts ...FileOption) error

CopyWriter ..

func Create

func Create(ctx context.Context, file string, opts ...FileOption) (io.WriteCloser, error)

Create creates a writer

func Open

func Open(ctx context.Context, file string, opts ...FileOption) (io.ReadCloser, error)

Open opens a reader

func Stat

func Stat(ctx context.Context, file string, opts ...FileOption) (os.FileInfo, error)

Stat gets a file stat

Types

type CopyProgress

type CopyProgress func(total, current int64)

CopyProgress ...

type FileOption

type FileOption func(*FileOptions) error

FileOption ...

func WithContext

func WithContext(ctx context.Context) FileOption

WithContext ...

func WithEnvs

func WithEnvs(envs map[string]string) FileOption

WithEnvs ...

func WithProgress

func WithProgress(totalSize int64, progress CopyProgress) FileOption

WithProgress ...

type FileOptions

type FileOptions struct {
	// Context the context
	Context context.Context
	// TotalSize the size of source
	TotalSize int64
	// Progress the progress callback
	Progress CopyProgress
	// Envs the local enviorment variables
	Envs map[string]string
}

FileOptions ...

type FileUtil

type FileUtil interface {
	// Stat ..
	Stat(ctx context.Context, file string, opts ...FileOption) (os.FileInfo, error)
	// Create creates a writer
	Create(ctx context.Context, file string, opts ...FileOption) (io.WriteCloser, error)
	// Open opens a reader
	Open(ctx context.Context, file string, opts ...FileOption) (io.ReadCloser, error)
	// Copy ..
	Copy(ctx context.Context, dst io.Writer, src io.Reader, opts ...FileOption) error
	// CopyFile ..
	CopyFile(ctx context.Context, dstFile, srcFile string, opts ...FileOption) error
	// CopyReader ..
	CopyReader(ctx context.Context, dstFile string, src io.Reader, opts ...FileOption) error
	// CopyWriter ..
	CopyWriter(ctx context.Context, dst io.Writer, srcFile string, opts ...FileOption) error
}

FileUtil file utilties

var (
	// Default default file util
	Default FileUtil = &defaultHandler{
		fileHandler: &fileHandler{},
		s3Handler:   &s3Handler{},
		httpHandler: &httpHandler{},
	}
)