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

Improve some docs

This commit is contained in:
Matt Joiner 2016-04-20 20:10:10 +10:00
parent 93f914a6d3
commit 61acdf6184
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
t.go
View File

@ -12,9 +12,8 @@ func (t *Torrent) InfoHash() metainfo.Hash {
return t.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.
// Returns a channel that is closed when the info (.Info()) for the torrent
// has become available.
func (t *Torrent) GotInfo() <-chan struct{} {
return t.gotMetainfo
}
@ -102,6 +101,8 @@ func (t *Torrent) Name() string {
return t.name()
}
// The completed length of all the torrent data, in all its files. This is
// derived from the torrent info, when it is available.
func (t *Torrent) Length() int64 {
select {
case <-t.GotInfo():