From: Timo Sirainen <timo.sirainen@dovecot.fi>
Date: Mon, 30 Oct 2017 14:01:31 +0000 (+0200)
Subject: lib: Update struct istream comments
X-Git-Tag: 2.3.0.rc1~693
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=7b29ccd796fc75af86f827192d2f8c0e8f0087bb;p=thirdparty%2Fdovecot%2Fcore.git

lib: Update struct istream comments
---

diff --git a/src/lib/istream.h b/src/lib/istream.h
index d39ba04bde..e6ea155615 100644
--- a/src/lib/istream.h
+++ b/src/lib/istream.h
@@ -16,6 +16,8 @@ struct istream {
 	   EIO     - Internal error. Retrying may work, but it may also be
 	             because of a misconfiguration.
 	   EINVAL  - Stream is corrupted.
+
+	   If stream_errno != 0, eof==TRUE as well.
 	*/
 	int stream_errno;
 
@@ -25,8 +27,9 @@ struct istream {
 	bool readable_fd:1; /* fd can be read directly if necessary
 	                               (for sendfile()) */
 	bool seekable:1; /* we can seek() backwards */
-	bool eof:1; /* read() has reached to end of file
-	                       (but may still be data available in buffer) */
+	/* read() has reached to end of file (but there may still be data
+	   available in buffer) or stream_errno != 0 */
+	bool eof:1;
 
 	struct istream_private *real_stream;
 };