[tahoe-lafs-trac-stream] [Tahoe-LAFS] #2461: IReadable.read should document out-of-range errors

[Tahoe-LAFS]

#2461: IReadable.read should document out-of-range errors
-------------------------------+-----------------------------
     Reporter:  daira          |      Owner:  daira
         Type:  defect         |     Status:  new
     Priority:  normal         |  Milestone:  1.10.2
    Component:  documentation  |    Version:  1.10.1
   Resolution:                 |   Keywords:  interfaces docs
Launchpad Bug:                 |
-------------------------------+-----------------------------

Comment (by warner):

 I'll update it to express the current behavior: reject out-of-range reads,
 permit zero-length reads.

 The webapi continues to allow arbitrary oversized `Range:` headers, since
 `web/filenode.py` clips these to the filesize before calling `read()`.
 It's just internal callers who must meet the no-overrun requirement (and
 they can always read the whole file, `offset=0 size=None`, without paying
 attention to `get_size()` ahead of time).

--
Ticket URL: <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2461#comment:4>
Tahoe-LAFS <https://Tahoe-LAFS.org>
secure decentralized storage