aboutsummaryrefslogtreecommitdiff
path: root/include/cru/common/io/FileStream.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/cru/common/io/FileStream.h')
-rw-r--r--include/cru/common/io/FileStream.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/include/cru/common/io/FileStream.h b/include/cru/common/io/FileStream.h
index 9176739a..4eab612f 100644
--- a/include/cru/common/io/FileStream.h
+++ b/include/cru/common/io/FileStream.h
@@ -17,6 +17,11 @@
* (TODO: Currently the problem is that when I implemented for Windows and UNIX
* I didn't take this into consideration so I have to fix this inconsistency
* later.)
+ *
+ * The requirement of FileStream:
+ * 1. It must be derived from Stream, of course.
+ * 2. It must have a constructor FileStream(String path, io::OpenFlag flags), so
+ * user can construct one with the same interface.
*/
#pragma once