LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Projects Releases 28 Packages Wiki Activity

Update package overview Errors section.

Browse source 
Now that all errors are either underlying IO errors or of type
MessageError, update the package overview documentation accordingly.
This commit is contained in:
Dave Collins 2013-05-13 02:19:57 -05:00
parent 5b78dee7e1
commit a3226897f0
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc.go
View file

@ -140,12 +140,11 @@ from a remote peer is:
Errors
Most errors returned by this package are either the raw errors provided by
underlying calls to read/write from streams, or raw strings that describe
the error. See the documentation of each function for any exceptions. NOTE:
This is currently undergoing change to return errors of type MessageError for
issues which are not io related so the caller can differentiate between
general io errors and malformed messages.
Errors returned by this package are either the raw errors provided by underlying
calls to read/write from streams such as io.EOF, io.ErrUnexpectedEOF, and
io.ErrShortWrite, or of type btcwire.MessageError. This allows the caller to
differentiate between general IO errors and malformed messages through type
assertions.
Bitcoin Improvement Proposals