# Struct ethcore_util::standard::io::Cursor 1.0.0 [−] [src]

    pub struct Cursor<T> { /* fields omitted */ }

A `Cursor` wraps another type and provides it with a `Seek` implementation.

`Cursor`s are typically used with in-memory buffers to allow them to implement `Read` and/or `Write`, allowing these buffers to be used anywhere you might use a reader or writer that does actual I/O.

The standard library implements some I/O traits on various types which are commonly used as a buffer, like `Cursor<` `Vec` `<u8>>` and `Cursor<` `&[u8]` `>`.

# Examples

We may want to write bytes to a `File` in our production code, but use an in-memory buffer in our tests. We can do this with `Cursor`:

    use std::io::prelude::*;
    use std::io::{self, SeekFrom};
    use std::fs::File;

    // a library function we've written
    fn write_ten_bytes_at_end<W: Write + Seek>(writer: &mut W) -> io::Result<()> {
        try!(writer.seek(SeekFrom::End(-10)));

        for i in 0..10 {
            try!(writer.write(&[i]));
        }

        // all went well
        Ok(())
    }

    // Here's some code that uses this library function.
    //
    // We might want to use a BufReader here for efficiency, but let's
    // keep this example focused.
    let mut file = try!(File::create("foo.txt"));

    try!(write_ten_bytes_at_end(&mut file));

    // now let's write a test
    #[test]
    fn test_writes_bytes() {
        // setting up a real File is much more slow than an in-memory buffer,
        // let's use a cursor instead
        use std::io::Cursor;
        let mut buff = Cursor::new(vec![0; 15]);

        write_ten_bytes_at_end(&mut buff).unwrap();

        assert_eq!(&buff.get_ref()[5..15], &[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
    }

## Methods

### `impl<T> Cursor<T>`

#### `fn new(inner: T) -> Cursor<T>`

Creates a new cursor wrapping the provided underlying I/O object.

# Examples

    use std::io::Cursor;

    let buff = Cursor::new(Vec::new());

#### `fn into_inner(self) -> T`

Consumes this cursor, returning the underlying value.

# Examples

    use std::io::Cursor;

    let buff = Cursor::new(Vec::new());

    let vec = buff.into_inner();

#### `fn get_ref(&self) -> &T`

Gets a reference to the underlying value in this cursor.

# Examples

    use std::io::Cursor;

    let buff = Cursor::new(Vec::new());

    let reference = buff.get_ref();

#### `fn get_mut(&mut self) -> &mut T`

Gets a mutable reference to the underlying value in this cursor.

Care should be taken to avoid modifying the internal I/O state of the underlying value as it may corrupt this cursor's position.

# Examples

    use std::io::Cursor;

    let mut buff = Cursor::new(Vec::new());

    let reference = buff.get_mut();

#### `fn position(&self) -> u64`

Returns the current position of this cursor.

# Examples

    use std::io::Cursor;
    use std::io::prelude::*;
    use std::io::SeekFrom;

    let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);

    assert_eq!(buff.position(), 0);

    buff.seek(SeekFrom::Current(2)).unwrap();
    assert_eq!(buff.position(), 2);

    buff.seek(SeekFrom::Current(-1)).unwrap();
    assert_eq!(buff.position(), 1);

#### `fn set_position(&mut self, pos: u64)`

Sets the position of this cursor.

# Examples

    use std::io::Cursor;

    let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);

    assert_eq!(buff.position(), 0);

    buff.set_position(2);
    assert_eq!(buff.position(), 2);

    buff.set_position(4);
    assert_eq!(buff.position(), 4);

## Trait Implementations

### `impl<T> Clone for Cursor<T> where T: Clone`

#### `fn clone(&self) -> Cursor<T>`

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`

Performs copy-assignment from `source`. Read more

### `impl<T> BufRead for Cursor<T> where T: AsRef<[u8]>`

#### `fn fill_buf(&mut self) -> Result<&[u8], Error>`

Fills the internal buffer of this object, returning the buffer contents. Read more

#### `fn consume(&mut self, amt: usize)`

Tells this buffer that `amt` bytes have been consumed from the buffer, so they should no longer be returned in calls to `read`. Read more

#### `fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>`

Read all bytes into `buf` until the delimiter `byte` or EOF is reached. Read more

#### `fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>`

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer. Read more

#### `fn split(self, byte: u8) -> Split<Self>`

Returns an iterator over the contents of this reader split on the byte `byte`. Read more

#### `fn lines(self) -> Lines<Self>`

Returns an iterator over the lines of this reader. Read more

### `impl<'a> Write for Cursor<&'a mut [u8]>`

#### `fn write(&mut self, data: &[u8]) -> Result<usize, Error>`

Write a buffer into this object, returning how many bytes were written. Read more

#### `fn flush(&mut self) -> Result<(), Error>`

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

#### `fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>`

Attempts to write an entire buffer into this write. Read more

#### `fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>`

Writes a formatted string into this writer, returning any error encountered. Read more

#### `fn by_ref(&mut self) -> &mut Self`

Creates a "by reference" adaptor for this instance of `Write`. Read more

### `impl Write for Cursor<Vec<u8>>`

#### `fn write(&mut self, buf: &[u8]) -> Result<usize, Error>`

Write a buffer into this object, returning how many bytes were written. Read more

#### `fn flush(&mut self) -> Result<(), Error>`

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

#### `fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>`

Attempts to write an entire buffer into this write. Read more

#### `fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>`

Writes a formatted string into this writer, returning any error encountered. Read more

#### `fn by_ref(&mut self) -> &mut Self`

Creates a "by reference" adaptor for this instance of `Write`. Read more

### `impl Write for Cursor<Box<[u8]>>`
1.5.0

#### `fn write(&mut self, buf: &[u8]) -> Result<usize, Error>`

Write a buffer into this object, returning how many bytes were written. Read more

#### `fn flush(&mut self) -> Result<(), Error>`

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

#### `fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>`

Attempts to write an entire buffer into this write. Read more

#### `fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>`

Writes a formatted string into this writer, returning any error encountered. Read more

#### `fn by_ref(&mut self) -> &mut Self`

Creates a "by reference" adaptor for this instance of `Write`. Read more

### `impl<T> Debug for Cursor<T> where T: Debug`

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>`

Formats the value using the given formatter.

### `impl<T> Read for Cursor<T> where T: AsRef<[u8]>`

#### `fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>`

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

#### `fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>`

Read all bytes until EOF in this source, placing them into `buf`. Read more

#### `fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>`

Read all bytes until EOF in this source, placing them into `buf`. Read more

#### `fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>`
1.6.0

Read the exact number of bytes required to fill `buf`. Read more

#### `fn by_ref(&mut self) -> &mut Self`

Creates a "by reference" adaptor for this instance of `Read`. Read more

#### `fn bytes(self) -> Bytes<Self>`

Transforms this `Read` instance to an `Iterator` over its bytes. Read more

#### `fn chars(self) -> Chars<Self>`

Unstable (`io`)

: the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this `Read` instance to an `Iterator` over `char`s. Read more

#### `fn chain<R>(self, next: R) -> Chain<Self, R> where R: Read`

Creates an adaptor which will chain this stream with another. Read more

#### `fn take(self, limit: u64) -> Take<Self>`

Creates an adaptor which will read at most `limit` bytes from it. Read more

### `impl<T> Seek for Cursor<T> where T: AsRef<[u8]>`

#### `fn seek(&mut self, style: SeekFrom) -> Result<u64, Error>`

Seek to an offset, in bytes, in a stream. Read more

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)