par2

Documentation

Index

• type Decoder
  • func NewDecoder(delegate DecoderDelegate, indexFile string, numGoroutines int) (*Decoder, error)
  • func (d *Decoder) LoadFileData() error
  • func (d *Decoder) LoadParityData() error
  • func (d *Decoder) Repair(checkParity bool) ([]string, error)
  • func (d *Decoder) Verify() (needsRepair bool, err error)
• type DecoderDelegate
• type Encoder
  • func NewEncoder(delegate EncoderDelegate, filePaths []string, ...) (*Encoder, error)
  • func (e *Encoder) ComputeParityData() error
  • func (e *Encoder) LoadFileData() error
  • func (e *Encoder) Write(indexPath string) error
• type EncoderDelegate

Types

type Decoder

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

A Decoder keeps track of all information needed to check the integrity of a set of data files, and possibly repair any missing/corrupted data files from the parity files (that usually end in .par2).

func NewDecoder

func NewDecoder(delegate DecoderDelegate, indexFile string, numGoroutines int) (*Decoder, error)

NewDecoder reads the given index file, which usually has a .par2 extension.

func (*Decoder) LoadFileData

func (d *Decoder) LoadFileData() error

LoadFileData loads existing file data into memory.

func (*Decoder) LoadParityData

func (d *Decoder) LoadParityData() error

LoadParityData searches for parity volumes and loads them into memory.

func (*Decoder) Repair

func (d *Decoder) Repair(checkParity bool) ([]string, error)

Repair tries to repair any missing or corrupted data, using the parity volumes. Returns a list of files that were successfully repaired, which is present even if an error is returned. If checkParity is true, extra checking is done of the reconstructed parity data.

func (*Decoder) Verify

func (d *Decoder) Verify() (needsRepair bool, err error)

Verify checks whether repair is needed. It returns a bool for needsRepair and an error; if error is non-nil, needsRepair may or may not be filled in.

type DecoderDelegate

type DecoderDelegate interface {
	OnCreatorPacketLoad(clientID string)
	OnMainPacketLoad(sliceByteCount, recoverySetCount, nonRecoverySetCount int)
	OnFileDescriptionPacketLoad(fileID [16]byte, filename string, byteCount int)
	OnIFSCPacketLoad(fileID [16]byte)
	OnRecoveryPacketLoad(exponent uint16, byteCount int)
	OnUnknownPacketLoad(packetType [16]byte, byteCount int)
	OnOtherPacketSkip(setID [16]byte, packetType [16]byte, byteCount int)
	OnDataFileLoad(i, n int, path string, byteCount, hits, misses int, err error)
	OnParityFileLoad(i int, path string, err error)
	OnDetectCorruptDataChunk(fileID [16]byte, filename string, startByteOffset, endByteOffset int)
	OnDetectDataFileHashMismatch(fileID [16]byte, filename string)
	OnDetectDataFileWrongByteCount(fileID [16]byte, filename string)
	OnDataFileWrite(i, n int, path string, byteCount int, err error)
}

DecoderDelegate holds methods that are called during the decode process.

type Encoder

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

An Encoder keeps track of all information needed to create parity volumes for a set of data files, and write them out to parity files (that usually end in .par2).

func NewEncoder

func NewEncoder(delegate EncoderDelegate, filePaths []string, sliceByteCount, parityShardCount, numGoroutines int) (*Encoder, error)

NewEncoder creates an encoder with the given list of file paths, and with the given number of intended parity volumes.

func (*Encoder) ComputeParityData

func (e *Encoder) ComputeParityData() error

ComputeParityData computes the parity data for the files.

func (*Encoder) LoadFileData

func (e *Encoder) LoadFileData() error

LoadFileData loads the file data into memory.

func (*Encoder) Write

func (e *Encoder) Write(indexPath string) error

type EncoderDelegate

type EncoderDelegate interface {
	OnDataFileLoad(i, n int, path string, byteCount int, err error)
	OnIndexFileWrite(path string, byteCount int, err error)
	OnRecoveryFileWrite(start, count, total int, path string, dataByteCount, byteCount int, err error)
}

EncoderDelegate holds methods that are called during the encode process.