[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 daira):

 Replying to [comment:2 zooko]:
 > I think the behavior ought to be to return a short result, i.e. return
 as many bytes as *do* exist and fall within the requested range, and
 return the 0-length string if none do. That way clients can issue range
 read requests without knowing for sure whether the request will start past
 the end or cross the end, which can allow them to do fewer round trips,
 maybe, in some cases.

 That's a self-consistent design, but it is not the current design (which
 is for the web-API to truncate the request as necessary). No extra round
 trips are ever needed, because the file length is known at the time the
 web-API makes the `read` call. Also the design change you suggest is not
 needed to fix #2459, the bug that motivated this ticket. I am skeptical
 about doing anything more than necessary to fix that bug in a point
 release.

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