Skip to content

Commit

Permalink
Refine Cursor docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
nagisa committed Mar 22, 2015
1 parent ecf8c64 commit 90c8592
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions src/libstd/io/cursor.rs
Expand Up @@ -17,17 +17,14 @@ use iter::repeat;
use num::Int;
use slice;

/// A `Cursor` is a type which wraps another I/O object to provide a `Seek`
/// A `Cursor` is a type which wraps a non-I/O object to provide a `Seek`
/// implementation.
///
/// Cursors are currently typically used with memory buffer objects in order to
/// allow `Seek` plus `Read` and `Write` implementations. For example, common
/// cursor types include:
/// Cursors are typically used with memory buffer objects in order to allow
/// `Seek`, `Read`, and `Write` implementations. For example, common cursor types
/// include `Cursor<Vec<u8>>` and `Cursor<&[u8]>`.
///
/// * `Cursor<Vec<u8>>`
/// * `Cursor<&[u8]>`
///
/// Implementations of the I/O traits for `Cursor<T>` are not currently generic
/// Implementations of the I/O traits for `Cursor<T>` are currently not generic
/// over `T` itself. Instead, specific implementations are provided for various
/// in-memory buffer types like `Vec<u8>` and `&[u8]`.
#[stable(feature = "rust1", since = "1.0.0")]
Expand Down

0 comments on commit 90c8592

Please sign in to comment.