JakeHillion/storj
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

lib/uplinkc: add clarifying comments to download_read (#3525)

Browse Source
This commit is contained in:
Egon Elbre 2019-11-11 16:11:37 +02:00 committed by GitHub
parent 20eef5a20a
commit f3e803203b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/uplinkc/object.go
View File

@ -279,6 +279,11 @@ func download(bucketRef C.BucketRef, path *C.char, cErr **C.char) C.DownloaderRe
}
//export download_read
// download_read reads data upto `length` bytes into `bytes` buffer and returns
// the count of bytes read. The exact number of bytes returned depends on different
// buffers and what is currently available.
// When there is no more data available function returns 0.
// On an error cErr is set, however some data may still be returned.
func download_read(downloader C.DownloaderRef, bytes *C.uint8_t, length C.size_t, cErr **C.char) C.size_t {
download, ok := universe.Get(downloader._handle).(*Download)
if !ok {