progress

Documentation

Index

• Constants
• type FctEOF
• type FctIncrement
• type FctReset
• type File
• type GenericIO
• type Progress
  • func Create(name string) (Progress, error)
  • func New(name string, flags int, perm os.FileMode) (Progress, error)
  • func Open(name string) (Progress, error)
  • func Temp(pattern string) (Progress, error)
  • func Unique(basePath, pattern string) (Progress, error)

Constants

const (
	ErrorParamEmpty liberr.CodeError = iota + liberr.MinPkgFileProgress
	ErrorSyscallRLimitGet
	ErrorSyscallRLimitSet
	ErrorIOFileStat
	ErrorIOFileSeek
	ErrorIOFileTruncate
	ErrorIOFileSync
	ErrorIOFileOpen
	ErrorIOFileTempNew
	ErrorIOFileTempClose
	ErrorIOFileTempRemove
	ErrorNilPointer
)

const DefaultBuffSize = 32 * 1024 // see io.copyBuffer

Types

type FctEOF

type FctEOF func()

type FctIncrement

type FctIncrement func(size int64)

type FctReset

type FctReset func(size, current int64)

type File

type File interface {
	CloseDelete() error

	Path() string
	Stat() (os.FileInfo, error)

	SizeBOF() (size int64, err error)
	SizeEOF() (size int64, err error)

	Truncate(size int64) error
	Sync() error
}

type GenericIO

type GenericIO interface {
	io.ReadCloser
	io.ReadSeeker
	io.ReadWriteCloser
	io.ReadWriteSeeker
	io.WriteCloser
	io.WriteSeeker
	io.Reader
	io.ReaderFrom
	io.ReaderAt
	io.Writer
	io.WriterAt
	io.WriterTo
	io.Seeker
	io.StringWriter
	io.Closer
	io.ByteReader
	io.ByteWriter
}

type Progress

type Progress interface {
	GenericIO
	File

	RegisterFctIncrement(fct FctIncrement)
	RegisterFctReset(fct FctReset)
	RegisterFctEOF(fct FctEOF)
	SetBufferSize(size int32)
	SetRegisterProgress(f Progress)

	Reset(max int64)
}

func Create

func Create(name string) (Progress, error)

func New

func New(name string, flags int, perm os.FileMode) (Progress, error)

func Open

func Open(name string) (Progress, error)

func Temp

func Temp(pattern string) (Progress, error)

func Unique

func Unique(basePath, pattern string) (Progress, error)