metainfo

README

A library for manipulating ".torrent" files.

Documentation

Index

• type FileInfo
• type Hash
  • func HashBytes(b []byte) (ret Hash)
  • func NewHashFromHex(s string) (h Hash)
  • func (h Hash) AsString() string
  • func (h Hash) Bytes() []byte
  • func (h *Hash) FromHexString(s string) (err error)
  • func (h Hash) HexString() string
• type Info
  • func (info *Info) BuildFromFilePath(root string) (err error)
  • func (info *Info) GeneratePieces(open func(fi FileInfo) (io.ReadCloser, error)) error
  • func (info *Info) IsDir() bool
  • func (info *Info) NumPieces() int
  • func (info *Info) Piece(index int) Piece
  • func (info *Info) TotalLength() (ret int64)
  • func (info *Info) UpvertedFiles() []FileInfo
• type Magnet
  • func ParseMagnetURI(uri string) (m Magnet, err error)
  • func (m Magnet) String() string
• type MetaInfo
  • func Load(r io.Reader) (*MetaInfo, error)
  • func LoadFromFile(filename string) (*MetaInfo, error)
  • func (mi MetaInfo) HashInfoBytes() (infoHash Hash)
  • func (mi *MetaInfo) Magnet(displayName string, infoHash Hash) (m Magnet)
  • func (mi *MetaInfo) SetDefaults()
  • func (mi MetaInfo) UnmarshalInfo() (info Info, err error)
  • func (mi MetaInfo) Write(w io.Writer) error
• type Node
  • func (n *Node) UnmarshalBencode(b []byte) (err error)
• type Piece
  • func (p Piece) Hash() (ret Hash)
  • func (p Piece) Index() int
  • func (p Piece) Length() int64
  • func (p Piece) Offset() int64
• type PieceKey

Types

type FileInfo

type FileInfo struct {
	Length int64    `bencode:"length"`
	Path   []string `bencode:"path"`
}

Information specific to a single file inside the MetaInfo structure.

type Hash

type Hash [20]byte

20-byte SHA1 hash used for info and pieces.

func HashBytes

func HashBytes(b []byte) (ret Hash)

func NewHashFromHex

func NewHashFromHex(s string) (h Hash)

func (Hash) AsString

func (h Hash) AsString() string

func (Hash) Bytes

func (h Hash) Bytes() []byte

func (*Hash) FromHexString

func (h *Hash) FromHexString(s string) (err error)

func (Hash) HexString

func (h Hash) HexString() string

type Info

type Info struct {
	PieceLength int64      `bencode:"piece length"`
	Pieces      []byte     `bencode:"pieces"`
	Name        string     `bencode:"name"`
	Length      int64      `bencode:"length,omitempty"`
	Private     *bool      `bencode:"private,omitempty"`
	Source      string     `bencode:"source,omitempty"`
	Files       []FileInfo `bencode:"files,omitempty"`
}

The info dictionary.

func (*Info) BuildFromFilePath

func (info *Info) BuildFromFilePath(root string) (err error)

This is a helper that sets Files and Pieces from a root path and its children.

func (*Info) GeneratePieces

func (info *Info) GeneratePieces(open func(fi FileInfo) (io.ReadCloser, error)) error

Set info.Pieces by hashing info.Files.

func (*Info) IsDir

func (info *Info) IsDir() bool

func (*Info) NumPieces

func (info *Info) NumPieces() int

func (*Info) Piece

func (info *Info) Piece(index int) Piece

func (*Info) TotalLength

func (info *Info) TotalLength() (ret int64)

func (*Info) UpvertedFiles

func (info *Info) UpvertedFiles() []FileInfo

The files field, converted up from the old single-file in the parent info dict if necessary. This is a helper to avoid having to conditionally handle single and multi-file torrent infos.

type Magnet

type Magnet struct {
	InfoHash    Hash
	Trackers    []string
	DisplayName string
}

Magnet link components.

func ParseMagnetURI

func ParseMagnetURI(uri string) (m Magnet, err error)

ParseMagnetURI parses Magnet-formatted URIs into a Magnet instance

func (Magnet) String

func (m Magnet) String() string

type MetaInfo

type MetaInfo struct {
	InfoBytes    bencode.Bytes `bencode:"info"`
	Announce     string        `bencode:"announce,omitempty"`
	AnnounceList [][]string    `bencode:"announce-list,omitempty"`
	Nodes        []Node        `bencode:"nodes,omitempty"`
	CreationDate int64         `bencode:"creation date,omitempty"`
	Comment      string        `bencode:"comment,omitempty"`
	CreatedBy    string        `bencode:"created by,omitempty"`
	Encoding     string        `bencode:"encoding,omitempty"`
	URLList      interface{}   `bencode:"url-list,omitempty"`
}

func Load

func Load(r io.Reader) (*MetaInfo, error)

Load a MetaInfo from an io.Reader. Returns a non-nil error in case of failure.

func LoadFromFile

func LoadFromFile(filename string) (*MetaInfo, error)

Convenience function for loading a MetaInfo from a file.

func (MetaInfo) HashInfoBytes

func (mi MetaInfo) HashInfoBytes() (infoHash Hash)

func (*MetaInfo) Magnet

func (mi *MetaInfo) Magnet(displayName string, infoHash Hash) (m Magnet)

Creates a Magnet from a MetaInfo.

func (*MetaInfo) SetDefaults

func (mi *MetaInfo) SetDefaults()

Set good default values in preparation for creating a new MetaInfo file.

func (MetaInfo) UnmarshalInfo

func (mi MetaInfo) UnmarshalInfo() (info Info, err error)

func (MetaInfo) Write

func (mi MetaInfo) Write(w io.Writer) error

Encode to bencoded form.

type Node

type Node string

func (*Node) UnmarshalBencode

func (n *Node) UnmarshalBencode(b []byte) (err error)

type Piece

type Piece struct {
	Info *Info
	// contains filtered or unexported fields
}

func (Piece) Hash

func (p Piece) Hash() (ret Hash)

func (Piece) Index

func (p Piece) Index() int

func (Piece) Length

func (p Piece) Length() int64

func (Piece) Offset

func (p Piece) Offset() int64

type PieceKey

type PieceKey struct {
	InfoHash Hash
	Index    int
}

Uniquely identifies a piece.