nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-01-21 20:23:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

auto merge of #6621 : steveklabnik/rust/expand_reader_docs, r=thestinger

Browse Source 
Had a conversation with @cmr in IRC about some places that these
docs were confusing. The functions that advance the stream now say so.

In addition, I think that calling out the similarities to familliar C
functions should help people coming from other languages.
This commit is contained in:
bors 2013-05-19 23:13:36 -07:00
commit d019e145c0
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/libcore/io.rs
View File

@ -114,14 +114,16 @@ pub trait Reader {
// FIXME (#2982): This should probably return an error. // FIXME (#2982): This should probably return an error.
/** /**
* Reads bytes and puts them into `bytes`. Returns the number of * Reads bytes and puts them into `bytes`, advancing the cursor. Returns the
* bytes read. * number of bytes read.
* *
* The number of bytes to be read is `len` or the end of the file, * The number of bytes to be read is `len` or the end of the file,
* whichever comes first. * whichever comes first.
* *
* The buffer must be at least `len` bytes long. * The buffer must be at least `len` bytes long.
* *
* `read` is conceptually similar to C's `fread` function.
*
* # Examples * # Examples
* *
* None right now. * None right now.
@ -129,10 +131,12 @@ pub trait Reader {
fn read(&self, bytes: &mut [u8], len: uint) -> uint; 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. * In the case of an EOF or an error, returns a negative value.
* *
* `read_byte` is conceptually similar to C's `getc` function.
*
* # Examples * # Examples
* *
* None right now. * None right now.
@ -142,6 +146,8 @@ pub trait Reader {
/** /**
* Returns a boolean value: are we currently at EOF? * Returns a boolean value: are we currently at EOF?
* *
* `eof` is conceptually similar to C's `feof` function.
*
* # Examples * # Examples
* *
* None right now. * None right now.
@ -154,6 +160,8 @@ pub trait Reader {
* Takes an optional SeekStyle, which affects how we seek from the * Takes an optional SeekStyle, which affects how we seek from the
* position. See `SeekStyle` docs for more details. * position. See `SeekStyle` docs for more details.
* *
* `seek` is conceptually similar to C's `fseek` function.
*
* # Examples * # Examples
* *
* None right now. * None right now.
@ -163,6 +171,8 @@ pub trait Reader {
/** /**
* Returns the current position within the stream. * Returns the current position within the stream.
* *
* `tell` is conceptually similar to C's `ftell` function.
*
* # Examples * # Examples
* *
* None right now. * None right now.