part

Documentation

Index

• Variables
• type Config
• type File
  • func New(filePath string, curIndex int64, autoClose bool) *File
  • func (t *File) Close() error
  • func (t *File) CopyFromIoReader(from io.Reader, copyIOConfig pio.CopyConfig) error
  • func (t *File) CopyTo(to *File, copyIOConfig pio.CopyConfig, tryLock bool) error
  • func (t *File) CopyToIoWriter(to io.Writer, copyIOConfig pio.CopyConfig) error
  • func (t *File) CopyToUntil(to *File, untilBytes []byte, perReadSize int, maxReadSize int, tryLock bool) (e error)
  • func (t *File) Create(mode ...fs.FileMode)
  • func (t *File) CurIndex() (ret int64, err error)
  • func (t *File) Delete() error
  • func (t *File) DirFiles() (files []string, err error)
  • func (t *File) File() *os.File
  • func (t *File) GetFileModTime() (mod int64, err error)
  • func (t *File) GetFileSize() (int64, error)
  • func (t *File) HavePerm(want os.FileMode) (bool, error)
  • func (t *File) IsDir() bool
  • func (t *File) IsExist() bool
  • func (t *File) IsOpen() bool
  • func (t *File) Read(data []byte) (int, error)
  • func (t *File) ReadAll(perReadSize int, maxReadSize int) (data []byte, e error)
  • func (t *File) ReadUntil(untilBytes []byte, perReadSize int, maxReadSize int) (data []byte, e error)
  • func (t *File) SeekIndex(index int64, whence FileWhence) (e error)
  • func (t *File) SeekUntil(untilBytes []byte, whence FileWhence, perReadSize int, maxReadSize int) (e error)
  • func (t *File) Stat() (fs.FileInfo, error)
  • func (t *File) Sync() (e error)
  • func (t *File) Write(data []byte, tryLock bool) (int, error)
• type FileWhence

Variables

var (
	ErrFilePathTooLong  = errors.New("ErrFilePathTooLong")
	ErrNewFileCantSeed  = errors.New("ErrNewFileCantSeed")
	ErrFailToLock       = errors.New("ErrFailToLock")
	ErrMaxReadSizeReach = errors.New("ErrMaxReadSizeReach")
	ErrNoDir            = errors.New("ErrNoDir")
	ErrArg              = errors.New("ErrArg")
)

Types

type Config

type Config struct {
	FilePath  string //文件路径
	CurIndex  int64  //初始化光标位置
	AutoClose bool   //自动关闭句柄

	// wrap with encoder
	//https://pkg.go.dev/golang.org/x/text/encoding#section-directories
	Coder encoder.Encoding
}

type File

type File struct {
	Config Config
	// contains filtered or unexported fields
}

func New

func New(filePath string, curIndex int64, autoClose bool) *File

func (*File) Close

func (t *File) Close() error

func (*File) CopyFromIoReader

func (t *File) CopyFromIoReader(from io.Reader, copyIOConfig pio.CopyConfig) error

func (*File) CopyTo

func (t *File) CopyTo(to *File, copyIOConfig pio.CopyConfig, tryLock bool) error

func (*File) CopyToIoWriter

func (t *File) CopyToIoWriter(to io.Writer, copyIOConfig pio.CopyConfig) error

func (*File) CopyToUntil

func (t *File) CopyToUntil(to *File, untilBytes []byte, perReadSize int, maxReadSize int, tryLock bool) (e error)

stop after untilBytes

data not include untilBytes

func (*File) Create

func (t *File) Create(mode ...fs.FileMode)

func (*File) CurIndex

func (t *File) CurIndex() (ret int64, err error)

func (*File) Delete

func (t *File) Delete() error

func (*File) DirFiles

func (t *File) DirFiles() (files []string, err error)

func (*File) File

func (t *File) File() *os.File

func (*File) GetFileModTime

func (t *File) GetFileModTime() (mod int64, err error)

func (*File) GetFileSize

func (t *File) GetFileSize() (int64, error)

func (*File) HavePerm

func (t *File) HavePerm(want os.FileMode) (bool, error)

func (*File) IsDir

func (t *File) IsDir() bool

func (*File) IsExist

func (t *File) IsExist() bool

func (*File) IsOpen

func (t *File) IsOpen() bool

func (*File) Read

func (t *File) Read(data []byte) (int, error)

func (*File) ReadAll

func (t *File) ReadAll(perReadSize int, maxReadSize int) (data []byte, e error)

func (*File) ReadUntil

func (t *File) ReadUntil(untilBytes []byte, perReadSize int, maxReadSize int) (data []byte, e error)

stop after untilBytes

data not include untilBytes

func (*File) SeekIndex

func (t *File) SeekIndex(index int64, whence FileWhence) (e error)

Seek sets the offset for the next Read or Write on file to offset

func (*File) SeekUntil

func (t *File) SeekUntil(untilBytes []byte, whence FileWhence, perReadSize int, maxReadSize int) (e error)

stop before untilBytes

func (*File) Stat

func (t *File) Stat() (fs.FileInfo, error)

func (*File) Sync

func (t *File) Sync() (e error)

func (*File) Write

func (t *File) Write(data []byte, tryLock bool) (int, error)

type FileWhence

type FileWhence int

const (
	AtOrigin FileWhence = iota
	AtCurrent
	AtEnd
)