---

bors · bors · commit bcf280217e67 · 2013-05-19T23:13:36.000-07:00
yaml --- r: 62521 b: refs/heads/snap-stage3 c: d019e14 h: refs/heads/master i: 62519: bb7fba4 v: v3
diff --git a/[refs] b/[refs]
@@ -1,7 +1,7 @@
 ---
 refs/heads/master: 2d28d645422c1617be58c8ca7ad9a457264ca850
 refs/heads/snap-stage1: e33de59e47c5076a89eadeb38f4934f58a3618a6
-refs/heads/snap-stage3: 3a481c0f88025318eba7c48907a5c1d966e01d27
+refs/heads/snap-stage3: d019e145c033ac60d4413321da21d3e877b4b786
 refs/heads/try: 7b78b52e602bb3ea8174f9b2006bff3315f03ef9
 refs/tags/release-0.1: 1f5c5126e96c79d22cb7862f75304136e204f105
 refs/heads/ndm: f3868061cd7988080c30d6d5bf352a5a5fe2460b
diff --git a/branches/snap-stage3/src/libcore/io.rs b/branches/snap-stage3/src/libcore/io.rs
@@ -114,25 +114,29 @@ pub trait Reader {
 
     // FIXME (#2982): This should probably return an error.
     /**
-    * Reads bytes and puts them into `bytes`. Returns the number of
-    * bytes read.
+    * Reads bytes and puts them into `bytes`, advancing the cursor. Returns the
+    * number of bytes read.
     *
     * The number of bytes to be read is `len` or the end of the file,
     * whichever comes first.
     *
     * The buffer must be at least `len` bytes long.
     *
+    * `read` is conceptually similar to C's `fread` function.
+    *
     * # Examples
     *
     * None right now.
     */
     fn read(&self, bytes: &mut [u8], len: uint) -> uint;
 
     /**
-    * Reads a single byte.
+    * Reads a single byte, advancing the cursor.
     *
     * In the case of an EOF or an error, returns a negative value.
     *
+    * `read_byte` is conceptually similar to C's `getc` function.
+    *
     * # Examples
     *
     * None right now.
@@ -142,6 +146,8 @@ pub trait Reader {
     /**
     * Returns a boolean value: are we currently at EOF?
     *
+    * `eof` is conceptually similar to C's `feof` function.
+    *
     * # Examples
     *
     * None right now.
@@ -154,6 +160,8 @@ pub trait Reader {
     * Takes an optional SeekStyle, which affects how we seek from the
     * position. See `SeekStyle` docs for more details.
     *
+    * `seek` is conceptually similar to C's `fseek` function.
+    *
     * # Examples
     *
     * None right now.
@@ -163,6 +171,8 @@ pub trait Reader {
     /**
     * Returns the current position within the stream.
     *
+    * `tell` is conceptually similar to C's `ftell` function.
+    *
     * # Examples
     *
     * None right now.

Original file line number	Diff line number	Diff line change
`@@ -114,25 +114,29 @@ pub trait Reader {`
`114`	`114`
`115`	`115`	`// FIXME (#2982): This should probably return an error.`
`116`	`116`	`/**`
`117`		- * Reads bytes and puts them into `bytes`. Returns the number of
`118`		`- * bytes read.`
	`117`	+ * Reads bytes and puts them into `bytes`, advancing the cursor. Returns the
	`118`	`+ * number of bytes read.`
`119`	`119`	`*`
`120`	`120`	* The number of bytes to be read is `len` or the end of the file,
`121`	`121`	`* whichever comes first.`
`122`	`122`	`*`
`123`	`123`	* The buffer must be at least `len` bytes long.
`124`	`124`	`*`
	`125`	+ * `read` is conceptually similar to C's `fread` function.
	`126`	`+ *`
`125`	`127`	`* # Examples`
`126`	`128`	`*`
`127`	`129`	`* None right now.`
`128`	`130`	`*/`
`129`	`131`	`fn read(&self, bytes: &mut [u8], len: uint) -> uint;`
`130`	`132`
`131`	`133`	`/**`
`132`		`- * Reads a single byte.`
	`134`	`+ * Reads a single byte, advancing the cursor.`
`133`	`135`	`*`
`134`	`136`	`* In the case of an EOF or an error, returns a negative value.`
`135`	`137`	`*`
	`138`	+ * `read_byte` is conceptually similar to C's `getc` function.
	`139`	`+ *`
`136`	`140`	`* # Examples`
`137`	`141`	`*`
`138`	`142`	`* None right now.`
`@@ -142,6 +146,8 @@ pub trait Reader {`
`142`	`146`	`/**`
`143`	`147`	`* Returns a boolean value: are we currently at EOF?`
`144`	`148`	`*`
	`149`	+ * `eof` is conceptually similar to C's `feof` function.
	`150`	`+ *`
`145`	`151`	`* # Examples`
`146`	`152`	`*`
`147`	`153`	`* None right now.`
`@@ -154,6 +160,8 @@ pub trait Reader {`
`154`	`160`	`* Takes an optional SeekStyle, which affects how we seek from the`
`155`	`161`	* position. See `SeekStyle` docs for more details.
`156`	`162`	`*`
	`163`	+ * `seek` is conceptually similar to C's `fseek` function.
	`164`	`+ *`
`157`	`165`	`* # Examples`
`158`	`166`	`*`
`159`	`167`	`* None right now.`
`@@ -163,6 +171,8 @@ pub trait Reader {`
`163`	`171`	`/**`
`164`	`172`	`* Returns the current position within the stream.`
`165`	`173`	`*`
	`174`	+ * `tell` is conceptually similar to C's `ftell` function.
	`175`	`+ *`
`166`	`176`	`* # Examples`
`167`	`177`	`*`
`168`	`178`	`* None right now.`