diff options
Diffstat (limited to 'src/membuf.h')
| -rw-r--r-- | src/membuf.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/src/membuf.h b/src/membuf.h index d98a29c..544dc83 100644 --- a/src/membuf.h +++ b/src/membuf.h | |||
| @@ -17,7 +17,12 @@ | |||
| 17 | namespace Bu | 17 | namespace Bu |
| 18 | { | 18 | { |
| 19 | /** | 19 | /** |
| 20 | * A memory buffer stream. | 20 | * A memory buffer stream. This provides a read/write stream in memory that |
| 21 | * works exactly like a file stream...only in memory. You can seed the | ||
| 22 | * memory buffer with a Bu::String of your own, or start with an empty one. | ||
| 23 | * Due to Bu::String using Bu::SharedCore starting with a string will not | ||
| 24 | * necesarilly cause the MemBuf to make a copy of your memory, but if you're | ||
| 25 | * sure you're not going to need to change the stream then use StaticMemBuf. | ||
| 21 | *@ingroup Streams | 26 | *@ingroup Streams |
| 22 | */ | 27 | */ |
| 23 | class MemBuf : public Stream | 28 | class MemBuf : public Stream |
