ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2025-03-25 13:07:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

IReadable.read(): document out-of-range errors

Browse Source 
closes ticket#2461
This commit is contained in:
Brian Warner 2015-07-28 13:01:15 -07:00
parent 8f615c8551
commit 6252a72965
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/allmydata/interfaces.py
View File

@ -665,7 +665,10 @@ class IReadable(Interface):
the last byte has been given to it, or because the consumer threw an
exception during write(), possibly because it no longer wants to
receive data). The portion downloaded will start at 'offset' and
contain 'size' bytes (or the remainder of the file if size==None).
contain 'size' bytes (or the remainder of the file if size==None). It
is an error to read beyond the end of the file: callers must use
get_size() and clip any non-default offset= and size= parameters. It
is permissible to read zero bytes.
The consumer will be used in non-streaming mode: an IPullProducer
will be attached to it.