Browse Source

Further clarified how StreamIn::IsEOF should behave

See #1418
Jorrit Rouwe 7 months ago
parent
commit
b40b2b6042
1 changed files with 2 additions and 1 deletions
  1. 2 1
      Jolt/Core/StreamIn.h

+ 2 - 1
Jolt/Core/StreamIn.h

@@ -18,7 +18,8 @@ public:
 	/// Read a string of bytes from the binary stream
 	/// Read a string of bytes from the binary stream
 	virtual void		ReadBytes(void *outData, size_t inNumBytes) = 0;
 	virtual void		ReadBytes(void *outData, size_t inNumBytes) = 0;
 
 
-	/// Returns true when an attempt has been made to read past the end of the file
+	/// Returns true when an attempt has been made to read past the end of the file.
+	/// Note that this follows the convention of std::basic_ios::eof which only returns true when an attempt is made to read past the end, not when the read pointer is at the end.
 	virtual bool		IsEOF() const = 0;
 	virtual bool		IsEOF() const = 0;
 
 
 	/// Returns true if there was an IO failure
 	/// Returns true if there was an IO failure