status-im
/
torrent
mirror of
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve various File related doc comments

This commit is contained in:
Matt Joiner 2018-01-07 11:57:02 +11:00
parent 87a033e074
commit 7f48246119
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
file.go
View File

@ -19,19 +19,22 @@ func (f *File) Torrent() *Torrent {
return f.t return f.t
} }
// Data for this file begins this far into the torrent. // Data for this file begins this many bytes into the Torrent.
func (f *File) Offset() int64 { func (f *File) Offset() int64 {
return f.offset return f.offset
} }
// The FileInfo from the metainfo.Info to which this file corresponds.
func (f File) FileInfo() metainfo.FileInfo { func (f File) FileInfo() metainfo.FileInfo {
return f.fi return f.fi
} }
// The file's path components joined by '/'.
func (f File) Path() string { func (f File) Path() string {
return f.path return f.path
} }
// The file's length in bytes.
func (f *File) Length() int64 { func (f *File) Length() int64 {
return f.length return f.length
} }
@ -47,6 +50,7 @@ func (f *File) DisplayPath() string {
} }
// The download status of a piece that comprises part of a File.
type FilePieceState struct { type FilePieceState struct {
Bytes int64 // Bytes within the piece that are part of this File. Bytes int64 // Bytes within the piece that are part of this File.
PieceState PieceState