about summary refs log tree commit diff
path: root/src/libstd/io/mem.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/libstd/io/mem.rs')
-rw-r--r--src/libstd/io/mem.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/libstd/io/mem.rs b/src/libstd/io/mem.rs
index 49c37b4520f..862368a8fa2 100644
--- a/src/libstd/io/mem.rs
+++ b/src/libstd/io/mem.rs
@@ -224,6 +224,8 @@ pub struct BufWriter<'a> {
 }
 
 impl<'a> BufWriter<'a> {
+    /// Creates a new `BufWriter` which will wrap the specified buffer. The
+    /// writer initially starts at position 0.
     pub fn new<'a>(buf: &'a mut [u8]) -> BufWriter<'a> {
         BufWriter {
             buf: buf,