pf

README

pf is progress file.

Installation

go get -u github.com/0x5010/pf

Usage

Documentation

Index

• Variables
• type PF
  • func New(filename string, fileSize int64, opts ...PFOption) (*PF, error)
  • func (pf *PF) Checked() bool
  • func (pf *PF) WaitFinish()
  • func (pf *PF) Write(index int, data []byte) error
• type PFOption
  • func SetHash(hash string) PFOption
  • func SetPieceCount(pieceCount int) PFOption
  • func SetPieceSize(pieceSize int64) PFOption
• type Progress
  • func LoadProgress(buf io.Reader) *Progress
  • func NewProgress(n int) *Progress
  • func (p *Progress) Add(x int)
  • func (p *Progress) Check() bool
  • func (p *Progress) Clear(x int)
  • func (p *Progress) Contains(x int) (bool, error)
  • func (p *Progress) FindFirstClear() int
  • func (p *Progress) Remove(x int)

Variables

var (
	// ErrOutOfBounds bitmap out of bounds
	ErrOutOfBounds = errors.New("out of bounds")
)

Types

type PF

type PF struct {
	Filepath   string
	Hash       string
	FileSize   int64
	PieceSize  int64
	PieceCount int
	Progress   *Progress
	// contains filtered or unexported fields
}

PF progress file

func New

func New(filename string, fileSize int64, opts ...PFOption) (*PF, error)

New initialization PF

func (*PF) Checked

func (pf *PF) Checked() bool

Checked check all done

func (*PF) WaitFinish

func (pf *PF) WaitFinish()

WaitFinish wait all done

func (*PF) Write

func (pf *PF) Write(index int, data []byte) error

Write write piece data to file

type PFOption

type PFOption func(*PF)

PFOption initialization option

func SetHash

func SetHash(hash string) PFOption

SetHash set PF Hash

func SetPieceCount

func SetPieceCount(pieceCount int) PFOption

SetPieceCount set PF PieceCount

func SetPieceSize

func SetPieceSize(pieceSize int64) PFOption

SetPieceSize set PF PieceSize

type Progress

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

Progress progress with bitmap

func LoadProgress

func LoadProgress(buf io.Reader) *Progress

LoadProgress load Progress from io.Reader

func NewProgress

func NewProgress(n int) *Progress

NewProgress new Progress

func (*Progress) Add

func (p *Progress) Add(x int)

Add finish x piece to progress

func (*Progress) Check

func (p *Progress) Check() bool

Check check progress finish

func (*Progress) Clear

func (p *Progress) Clear(x int)

Clear if runing piece fail, clear the runing piece in progress

func (*Progress) Contains

func (p *Progress) Contains(x int) (bool, error)

Contains check x finished

func (*Progress) FindFirstClear

func (p *Progress) FindFirstClear() int

FindFirstClear find first unfinshed piece in progress, mask x runing

func (*Progress) Remove

func (p *Progress) Remove(x int)

Remove unfinish x piece to progress