Struct std::io::Take1.0.0 [] [src]

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

Reader adaptor which limits the bytes read from an underlying reader.

This struct is generally created by calling take on a reader. Please see the documentation of take for more details.

Methods

impl<T> Take<T>
[src]

[src]

Returns the number of bytes that can be read before this instance will return EOF.

Note

This instance may reach EOF after reading fewer bytes than indicated by this method if the underlying Read instance reaches EOF.

Examples

use std::io;
use std::io::prelude::*;
use std::fs::File;

let f = File::open("foo.txt")?;

// read at most five bytes
let handle = f.take(5);

println!("limit: {}", handle.limit());Run

[src]

🔬 This is a nightly-only experimental API. (take_set_limit #42781)

Sets the number of bytes that can be read before this instance will return EOF. This is the same as constructing a new Take instance, so the amount of bytes read and the previous limit value don't matter when calling this method.

Examples

#![feature(take_set_limit)]
use std::io;
use std::io::prelude::*;
use std::fs::File;

let f = File::open("foo.txt")?;

// read at most five bytes
let mut handle = f.take(5);
handle.set_limit(10);

assert_eq!(handle.limit(), 10);Run

1.15.0
[src]

Consumes the Take, returning the wrapped reader.

Examples

use std::io;
use std::io::prelude::*;
use std::fs::File;

let mut file = File::open("foo.txt")?;

let mut buffer = [0; 5];
let mut handle = file.take(5);
handle.read(&mut buffer)?;

let file = handle.into_inner();Run

1.20.0
[src]

Gets a reference to the underlying reader.

Examples

use std::io;
use std::io::prelude::*;
use std::fs::File;

let mut file = File::open("foo.txt")?;

let mut buffer = [0; 5];
let mut handle = file.take(5);
handle.read(&mut buffer)?;

let file = handle.get_ref();Run

1.20.0
[src]

Gets a mutable reference to the underlying reader.

Care should be taken to avoid modifying the internal I/O state of the underlying reader as doing so may corrupt the internal limit of this Take.

Examples

use std::io;
use std::io::prelude::*;
use std::fs::File;

let mut file = File::open("foo.txt")?;

let mut buffer = [0; 5];
let mut handle = file.take(5);
handle.read(&mut buffer)?;

let file = handle.get_mut();Run

Trait Implementations

impl<T: Debug> Debug for Take<T>
[src]

[src]

Formats the value using the given formatter.

impl<T: Read> Read for Take<T>
[src]

[src]

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

[src]

🔬 This is a nightly-only experimental API. (read_initializer #42788)

Determines if this Reader can work with buffers of uninitialized memory. Read more

[src]

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

[src]

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

1.6.0
[src]

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

[src]

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

[src]

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

[src]

🔬 This is a nightly-only experimental API. (io #27802)

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

[src]

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

[src]

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

impl<T: BufRead> BufRead for Take<T>
[src]

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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