Refactorings

client.go

@@ -671,14 +671,14 @@ func (cl *Client) incomingConnection(nc net.Conn, utp bool) {
 }
 
 // Returns a handle to the given torrent, if it's present in the client.
-func (cl *Client) Torrent(ih InfoHash) (T Download, ok bool) {
+func (cl *Client) Torrent(ih InfoHash) (T Torrent, ok bool) {
 	cl.mu.Lock()
 	defer cl.mu.Unlock()
 	t, ok := cl.torrents[ih]
 	if !ok {
 		return
 	}
-	T = Torrent{cl, t}
+	T = clientTorrent{cl, t}
 	return
 }
 
@@ -2030,7 +2030,7 @@ type Handle interface {
 
 // Returns handles to the files in the torrent. This requires the metainfo is
 // available first.
-func (t Torrent) Files() (ret []File) {
+func (t clientTorrent) Files() (ret []File) {
 	t.cl.mu.Lock()
 	info := t.Info()
 	t.cl.mu.Unlock()
@@ -2052,7 +2052,7 @@ func (t Torrent) Files() (ret []File) {
 }
 
 // Marks the pieces in the given region for download.
-func (t Torrent) SetRegionPriority(off, len int64) {
+func (t clientTorrent) SetRegionPriority(off, len int64) {
 	t.cl.mu.Lock()
 	defer t.cl.mu.Unlock()
 	pieceSize := int64(t.usualPieceSize())
@@ -2061,7 +2061,7 @@ func (t Torrent) SetRegionPriority(off, len int64) {
 	}
 }
 
-func (t Torrent) AddPeers(pp []Peer) error {
+func (t clientTorrent) AddPeers(pp []Peer) error {
 	cl := t.cl
 	cl.mu.Lock()
 	defer cl.mu.Unlock()
@@ -2071,7 +2071,7 @@ func (t Torrent) AddPeers(pp []Peer) error {
 
 // Marks the entire torrent for download. Requires the info first, see
 // GotInfo.
-func (t Torrent) DownloadAll() {
+func (t clientTorrent) DownloadAll() {
 	t.cl.mu.Lock()
 	defer t.cl.mu.Unlock()
 	for i := range iter.N(t.numPieces()) {
@@ -2157,8 +2157,8 @@ func TorrentSpecFromMetaInfo(mi *metainfo.MetaInfo) (spec *TorrentSpec) {
 // trackers will be merged with the existing ones. If the Info isn't yet
 // known, it will be set. The display name is replaced if the new spec
 // provides one. Returns new if the torrent wasn't already in the client.
-func (cl *Client) AddTorrentSpec(spec *TorrentSpec) (D Download, new bool, err error) {
+func (cl *Client) AddTorrentSpec(spec *TorrentSpec) (D Torrent, new bool, err error) {
-	T := Torrent{}
+	T := clientTorrent{}
 	T.cl = cl
 	D = &T
 	cl.mu.Lock()
@@ -2722,16 +2722,16 @@ func (cl *Client) verifyPiece(t *torrent, piece int) {
 }
 
 // Returns handles to all the torrents loaded in the Client.
-func (me *Client) Torrents() (ret []Download) {
+func (me *Client) Torrents() (ret []Torrent) {
 	me.mu.Lock()
 	for _, t := range me.torrents {
-		ret = append(ret, Torrent{me, t})
+		ret = append(ret, clientTorrent{me, t})
 	}
 	me.mu.Unlock()
 	return
 }
 
-func (me *Client) AddMagnet(uri string) (T Download, err error) {
+func (me *Client) AddMagnet(uri string) (T Torrent, err error) {
 	spec, err := TorrentSpecFromMagnetURI(uri)
 	if err != nil {
 		return
@@ -2740,12 +2740,12 @@ func (me *Client) AddMagnet(uri string) (T Download, err error) {
 	return
 }
 
-func (me *Client) AddTorrent(mi *metainfo.MetaInfo) (T Download, err error) {
+func (me *Client) AddTorrent(mi *metainfo.MetaInfo) (T Torrent, err error) {
 	T, _, err = me.AddTorrentSpec(TorrentSpecFromMetaInfo(mi))
 	return
 }
 
-func (me *Client) AddTorrentFromFile(filename string) (T Download, err error) {
+func (me *Client) AddTorrentFromFile(filename string) (T Torrent, err error) {
 	mi, err := metainfo.LoadFromFile(filename)
 	if err != nil {
 		return

cmd/torrent-pick/main.go

@@ -134,7 +134,7 @@ func main() {
 
 	done := make(chan struct{})
 	for _, arg := range posArgs {
-		t := func() torrent.Download {
+		t := func() torrent.Torrent {
 			if strings.HasPrefix(arg, "magnet:") {
 				t, err := client.AddMagnet(arg)
 				if err != nil {

cmd/torrent/main.go

@@ -36,7 +36,7 @@ func resolvedPeerAddrs(ss []string) (ret []torrent.Peer, err error) {
 	return
 }
 
-func torrentBar(t torrent.Download) {
+func torrentBar(t torrent.Torrent) {
 	bar := uiprogress.AddBar(1)
 	bar.AppendCompleted()
 	bar.AppendFunc(func(*uiprogress.Bar) (ret string) {
@@ -69,7 +69,7 @@ func torrentBar(t torrent.Download) {
 
 func addTorrents(client *torrent.Client) {
 	for _, arg := range opts.Torrent {
-		t := func() torrent.Download {
+		t := func() torrent.Torrent {
 			if strings.HasPrefix(arg, "magnet:") {
 				t, err := client.AddMagnet(arg)
 				if err != nil {

download.go

@@ -1,27 +0,0 @@
-package torrent
-
-import(
-	"github.com/anacrolix/torrent/metainfo"
-	"github.com/anacrolix/missinggo/pubsub"
-	"github.com/anacrolix/torrent/tracker"
-)
-
-type Download interface {
-	InfoHash() InfoHash
-	GotInfo() <-chan struct{}
-	Info() *metainfo.Info
-	NewReader() (ret *Reader)
-	PieceStateRuns() []PieceStateRun
-	NumPieces() int
-	Drop()
-	BytesCompleted() int64
-	SubscribePieceStateChanges() *pubsub.Subscription
-	Seeding() bool
-	SetDisplayName(dn string)
-	Client() *Client
-	AddPeers(pp []Peer) error
-	DownloadAll()
-	Trackers() [][]tracker.Client
-	Files() (ret []File)
-	Peers() map[PeersKey]Peer
-}

file.go

@@ -8,14 +8,14 @@ import (
 
 // Provides access to regions of torrent data that correspond to its files.
 type File struct {
-	t      Torrent
+	t      clientTorrent
 	path   string
 	offset int64
 	length int64
 	fi     metainfo.FileInfo
 }
 
-func (f *File) Torrent() Download {
+func (f *File) Torrent() Torrent {
 	return f.t
 }
 

fs/torrentfs.go

@@ -50,7 +50,7 @@ type node struct {
 	path     string
 	metadata *metainfo.Info
 	FS       *TorrentFS
-	t        torrent.Download
+	t        torrent.Torrent
 }
 
 type fileNode struct {
@@ -69,7 +69,7 @@ func (n *node) fsPath() string {
 	return "/" + n.metadata.Name + "/" + n.path
 }
 
-func blockingRead(ctx context.Context, fs *TorrentFS, t torrent.Download, off int64, p []byte) (n int, err error) {
+func blockingRead(ctx context.Context, fs *TorrentFS, t torrent.Torrent, off int64, p []byte) (n int, err error) {
 	fs.mu.Lock()
 	fs.blockedReads++
 	fs.event.Broadcast()
@@ -101,7 +101,7 @@ func blockingRead(ctx context.Context, fs *TorrentFS, t torrent.Download, off in
 	return
 }
 
-func readFull(ctx context.Context, fs *TorrentFS, t torrent.Download, off int64, p []byte) (n int, err error) {
+func readFull(ctx context.Context, fs *TorrentFS, t torrent.Torrent, off int64, p []byte) (n int, err error) {
 	for len(p) != 0 {
 		var nn int
 		nn, err = blockingRead(ctx, fs, t, off, p)

issue35_test.go

@@ -1,15 +1,15 @@
 package torrent
 
 import (
-	"github.com/anacrolix/torrent/metainfo"
-	"testing"
-	"path/filepath"
-	"os"
-	"github.com/anacrolix/torrent/dht"
-	"io"
 	"errors"
 	"fmt"
+	"github.com/anacrolix/torrent/dht"
+	"github.com/anacrolix/torrent/metainfo"
+	"io"
+	"os"
+	"path/filepath"
 	"runtime"
+	"testing"
 )
 
 var numclients int = 0

reader.go

@@ -8,7 +8,7 @@ import (
 
 // Accesses torrent data via a client.
 type Reader struct {
-	t          *Torrent
+	t          *clientTorrent
 	pos        int64
 	responsive bool
 	readahead  int64

t.go

@@ -2,41 +2,62 @@ package torrent
 
 import (
 	"github.com/anacrolix/missinggo/pubsub"
-	"github.com/anacrolix/torrent/tracker"
 	"github.com/anacrolix/torrent/metainfo"
+	"github.com/anacrolix/torrent/tracker"
 )
 
 // This file contains Torrent, until I decide where the private, lower-case
 // "torrent" type belongs. That type is currently mostly in torrent.go.
 
-// The public handle to a live torrent within a Client.
+// The public interface to a live torrent within a Client.
-type Torrent struct {
+type Torrent interface {
+	InfoHash() InfoHash
+	GotInfo() <-chan struct{}
+	Info() *metainfo.Info
+	NewReader() (ret *Reader)
+	PieceStateRuns() []PieceStateRun
+	NumPieces() int
+	Drop()
+	BytesCompleted() int64
+	SubscribePieceStateChanges() *pubsub.Subscription
+	Seeding() bool
+	SetDisplayName(dn string)
+	Client() *Client
+	AddPeers(pp []Peer) error
+	DownloadAll()
+	Trackers() [][]tracker.Client
+	Files() (ret []File)
+	Peers() map[PeersKey]Peer
+}
+
+
+type clientTorrent struct {
 	cl *Client
 	*torrent
 }
 
 // The torrent's infohash. This is fixed and cannot change. It uniquely
 // identifies a torrent.
-func (t Torrent) InfoHash() InfoHash {
+func (t clientTorrent) InfoHash() InfoHash {
 	return t.torrent.InfoHash
 }
 
 // Closed when the info (.Info()) for the torrent has become available. Using
 // features of Torrent that require the info before it is available will have
 // undefined behaviour.
-func (t Torrent) GotInfo() <-chan struct{} {
+func (t clientTorrent) GotInfo() <-chan struct{} {
 	return t.torrent.gotMetainfo
 }
 
 // Returns the metainfo, or nil if it's not yet available.
-func (t Torrent) Info() *metainfo.Info {
+func (t clientTorrent) Info() *metainfo.Info {
 	return t.torrent.Info
 }
 
 // Returns a Reader bound to the torrent's data. All read calls block until
 // the data requested is actually available. Priorities are set to ensure the
 // data requested will be downloaded as soon as possible.
-func (t Torrent) NewReader() (ret *Reader) {
+func (t clientTorrent) NewReader() (ret *Reader) {
 	ret = &Reader{
 		t:         &t,
 		readahead: 5 * 1024 * 1024,
@@ -47,25 +68,25 @@ func (t Torrent) NewReader() (ret *Reader) {
 // Returns the state of pieces of the torrent. They are grouped into runs of
 // same state. The sum of the state run lengths is the number of pieces
 // in the torrent.
-func (t Torrent) PieceStateRuns() []PieceStateRun {
+func (t clientTorrent) PieceStateRuns() []PieceStateRun {
 	t.stateMu.Lock()
 	defer t.stateMu.Unlock()
 	return t.torrent.pieceStateRuns()
 }
 
-func (t Torrent) NumPieces() int {
+func (t clientTorrent) NumPieces() int {
 	return t.numPieces()
 }
 
 // Drop the torrent from the client, and close it.
-func (t Torrent) Drop() {
+func (t clientTorrent) Drop() {
 	t.cl.mu.Lock()
 	t.cl.dropTorrent(t.torrent.InfoHash)
 	t.cl.mu.Unlock()
 }
 
 // Number of bytes of the entire torrent we have completed.
-func (t Torrent) BytesCompleted() int64 {
+func (t clientTorrent) BytesCompleted() int64 {
 	t.cl.mu.RLock()
 	defer t.cl.mu.RUnlock()
 	return t.bytesCompleted()
@@ -73,13 +94,13 @@ func (t Torrent) BytesCompleted() int64 {
 
 // The subscription emits as (int) the index of pieces as their state changes.
 // A state change is when the PieceState for a piece alters in value.
-func (t Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
+func (t clientTorrent) SubscribePieceStateChanges() *pubsub.Subscription {
 	return t.torrent.pieceStateChanges.Subscribe()
 }
 
 // Returns true if the torrent is currently being seeded. This occurs when the
 // client is willing to upload without wanting anything in return.
-func (t Torrent) Seeding() bool {
+func (t clientTorrent) Seeding() bool {
 	t.cl.mu.Lock()
 	defer t.cl.mu.Unlock()
 	return t.cl.seeding(t.torrent)
@@ -87,23 +108,23 @@ func (t Torrent) Seeding() bool {
 
 // Clobbers the torrent display name. The display name is used as the torrent
 // name if the metainfo is not available.
-func (t Torrent) SetDisplayName(dn string) {
+func (t clientTorrent) SetDisplayName(dn string) {
 	t.cl.mu.Lock()
 	defer t.cl.mu.Unlock()
 	t.torrent.setDisplayName(dn)
 }
 
 // Client returns Torrent's client instance
-func (t Torrent) Client() *Client {
+func (t clientTorrent) Client() *Client {
 	return t.cl
 }
 
 // Trackers returns torrent's trackers
-func (t Torrent) Trackers() [][]tracker.Client {
+func (t clientTorrent) Trackers() [][]tracker.Client {
 	return t.torrent.Trackers
 }
 
 // Peers returns torrent's peers
-func (t Torrent) Peers() map[PeersKey]Peer {
+func (t clientTorrent) Peers() map[PeersKey]Peer {
 	return t.torrent.Peers
 }