From: nsf <no.smile.face@gmail.com>
Date: Sun, 1 Jul 2012 19:05:10 +0000 (+0600)
Subject: Cosmetic change File -> MetaInfo. Update docs as well.
X-Git-Tag: v1.0.0~1199^2~25
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=cfafbffbc1fdd4e7720cfd24d122d189b665f835;p=btrtrc.git

Cosmetic change File -> MetaInfo. Update docs as well.
---

diff --git a/torrent/file.go b/torrent/file.go
index be159a5f..9bd2285d 100644
--- a/torrent/file.go
+++ b/torrent/file.go
@@ -11,8 +11,8 @@ import (
 
 //----------------------------------------------------------------------------
 
-// SingleFile represents the specific data of the single file torrent file. That
-// includes length of the file and its recommended name.
+// SingleFile represents the specific data of the single file torrent
+// metainfo. That includes length of the file and its recommended name.
 type SingleFile struct {
 	Name   string
 	Length int64
@@ -21,14 +21,14 @@ type SingleFile struct {
 //----------------------------------------------------------------------------
 
 // MultiFile represents the specific data of the multiple files torrent
-// file. That includes Name of the directory which will contain all the files
-// and the files information.
+// metainfo. That includes the name of the directory which will contain all the
+// files and the files information.
 type MultiFile struct {
 	Name  string
 	Files []FileInfo
 }
 
-// Information of a single file in multiple files torrent file.
+// Information of a single file in multiple files torrent metainfo.
 type FileInfo struct {
 	Length int64
 	Path   []string
@@ -36,11 +36,11 @@ type FileInfo struct {
 
 //----------------------------------------------------------------------------
 
-// File is the type you should use when reading torrent files. See Load and
+// MetaInfo is the type you should use when reading torrent files. See Load and
 // LoadFromFile functions. All the fields are intended to be read-only. The
 // "Info" field has SingleFile or MultiFile type, use the type switch or type
 // assertion to determine the exact type.
-type File struct {
+type MetaInfo struct {
 	Info        interface{}
 	InfoHash    []byte
 	PieceLength int64
@@ -55,9 +55,10 @@ type File struct {
 	URLList      []string
 }
 
-// Load a File from an io.Reader. Returns a non-nil error in case of failure.
-func Load(r io.Reader) (*File, error) {
-	var file File
+// Load a MetaInfo from an io.Reader. Returns a non-nil error in case of
+// failure.
+func Load(r io.Reader) (*MetaInfo, error) {
+	var mi MetaInfo
 	var data torrent_data
 	d := bencode.NewDecoder(r)
 	err := d.Decode(&data)
@@ -74,34 +75,34 @@ func Load(r io.Reader) (*File, error) {
 				Path:   fi.Path,
 			}
 		}
-		file.Info = MultiFile{
+		mi.Info = MultiFile{
 			Name:  data.Info.Name,
 			Files: files,
 		}
 	} else {
-		file.Info = SingleFile{
+		mi.Info = SingleFile{
 			Name:   data.Info.Name,
 			Length: data.Info.Length,
 		}
 	}
-	file.InfoHash = data.Info.Hash
-	file.PieceLength = data.Info.PieceLength
-	file.Pieces = data.Info.Pieces
-	file.Private = data.Info.Private
+	mi.InfoHash = data.Info.Hash
+	mi.PieceLength = data.Info.PieceLength
+	mi.Pieces = data.Info.Pieces
+	mi.Private = data.Info.Private
 
 	if len(data.AnnounceList) > 0 {
-		file.AnnounceList = data.AnnounceList
+		mi.AnnounceList = data.AnnounceList
 	} else {
-		file.AnnounceList = [][]string{[]string{data.Announce}}
+		mi.AnnounceList = [][]string{[]string{data.Announce}}
 	}
-	file.CreationDate = time.Unix(data.CreationDate, 0)
-	file.Comment = data.Comment
-	file.CreatedBy = data.CreatedBy
-	file.Encoding = data.Encoding
+	mi.CreationDate = time.Unix(data.CreationDate, 0)
+	mi.Comment = data.Comment
+	mi.CreatedBy = data.CreatedBy
+	mi.Encoding = data.Encoding
 	if data.URLList != nil {
 		switch v := data.URLList.(type) {
 		case string:
-			file.URLList = []string{v}
+			mi.URLList = []string{v}
 		case []interface{}:
 			var ok bool
 			ss := make([]string, len(v))
@@ -111,16 +112,16 @@ func Load(r io.Reader) (*File, error) {
 					return nil, errors.New("bad url-list data type")
 				}
 			}
-			file.URLList = ss
+			mi.URLList = ss
 		default:
 			return nil, errors.New("bad url-list data type")
 		}
 	}
-	return &file, nil
+	return &mi, nil
 }
 
-// Convenience function for loading a torrent.File from a file.
-func LoadFromFile(filename string) (*File, error) {
+// Convenience function for loading a MetaInfo from a file.
+func LoadFromFile(filename string) (*MetaInfo, error) {
 	f, err := os.Open(filename)
 	if err != nil {
 		return nil, err
diff --git a/torrent/file_test.go b/torrent/file_test.go
index 917cce21..6e895b81 100644
--- a/torrent/file_test.go
+++ b/torrent/file_test.go
@@ -4,12 +4,12 @@ import "testing"
 import "path"
 
 func test_file(t *testing.T, filename string) {
-	f, err := LoadFromFile(filename)
+	mi, err := LoadFromFile(filename)
 	if err != nil {
 		t.Fatal(err)
 	}
 
-	switch info := f.Info.(type) {
+	switch info := mi.Info.(type) {
 	case SingleFile:
 		t.Logf("Single file: %s (length: %d)\n", info.Name, info.Length)
 	case MultiFile:
@@ -19,12 +19,12 @@ func test_file(t *testing.T, filename string) {
 		}
 	}
 
-	for _, group := range f.AnnounceList {
+	for _, group := range mi.AnnounceList {
 		for _, tracker := range group {
 			t.Logf("Tracker: %s\n", tracker)
 		}
 	}
-	for _, url := range f.URLList {
+	for _, url := range mi.URLList {
 		t.Logf("URL: %s\n", url)
 	}