yenc

Documentation

Overview

Package yenc gives a decoding interface for yEnc encoded binaries.

Index

• type DecodeError
  • func (d DecodeError) Error() string
• type Part
  • func NewPart(r io.Reader) (*Part, error)
  • func (y *Part) Read(b []byte) (n int, err error)

Types

type DecodeError

type DecodeError string

func (DecodeError) Error

func (d DecodeError) Error() string

type Part

type Part struct {
	Filename string
	Begin    int64
	Size     int64
	NumParts int
	Number   int
	// contains filtered or unexported fields
}

Part holds the information contained in a parsed yEnc header. It also implements the read interface for easy decoding. Normally, you will need to read the Filename to find out which file to open and Begin to know where to seek before writing.

func NewPart

func NewPart(r io.Reader) (*Part, error)

NewPart finds and parses the yEnc header in the reader and returns a part to use for further decoding.

func (*Part) Read

func (y *Part) Read(b []byte) (n int, err error)

Read will read the content of a yEnc part, obeying the normal read rules