[][src]Struct sgx_tstd::io::BufReader

pub struct BufReader<R> { /* fields omitted */ }

The BufReader struct adds buffering to any reader.

It can be excessively inefficient to work directly with a Read instance. For example, every call to read on TcpStream results in a system call. A BufReader performs large, infrequent reads on the underlying Read and maintains an in-memory buffer of the results.

BufReader can improve the speed of programs that make small and repeated read calls to the same file or network socket. It does not help when reading very large amounts at once, or reading just one or a few times. It also provides no advantage when reading from a source that is already in memory, like a Vec<u8>.

When the BufReader<R> is dropped, the contents of its buffer will be discarded. Creating multiple instances of a BufReader<R> on the same stream can cause data loss. Reading from the underlying reader after unwrapping the BufReader<R> with BufReader::into_inner can also cause data loss.


impl<R: Read> BufReader<R>[src]

pub fn new(inner: R) -> BufReader<R>[src]

Creates a new BufReader<R> with a default buffer capacity. The default is currently 8 KB, but may change in the future.

pub fn with_capacity(capacity: usize, inner: R) -> BufReader<R>[src]

Creates a new BufReader<R> with the specified buffer capacity.

impl<R> BufReader<R>[src]

pub fn get_ref(&self) -> &R[src]

Gets a reference to the underlying reader.

It is inadvisable to directly read from the underlying reader.

pub fn get_mut(&mut self) -> &mut R[src]

Gets a mutable reference to the underlying reader.

It is inadvisable to directly read from the underlying reader.

pub fn buffer(&self) -> &[u8][src]

Returns a reference to the internally buffered data.

Unlike fill_buf, this will not attempt to fill the buffer if it is empty.

pub fn capacity(&self) -> usize[src]

Returns the number of bytes the internal buffer can hold at once.

pub fn into_inner(self) -> R[src]

Unwraps this BufReader<R>, returning the underlying reader.

Note that any leftover data in the internal buffer is lost. Therefore, a following read from the underlying reader may lead to data loss.

impl<R: Seek> BufReader<R>[src]

pub fn seek_relative(&mut self, offset: i64) -> Result<()>[src]

Seeks relative to the current position. If the new position lies within the buffer, the buffer will not be flushed, allowing for more efficient seeks. This method does not return the location of the underlying reader, so the caller must track this information themselves if it is required.

Trait Implementations

impl<R: Read> BufRead for BufReader<R>[src]

impl<R> Debug for BufReader<R> where
    R: Debug

impl<R: Read> Read for BufReader<R>[src]

impl<R: Seek> Seek for BufReader<R>[src]

fn seek(&mut self, pos: SeekFrom) -> Result<u64>[src]

Seek to an offset, in bytes, in the underlying reader.

The position used for seeking with SeekFrom::Current(_) is the position the underlying reader would be at if the BufReader<R> had no internal buffer.

Seeking always discards the internal buffer, even if the seek position would otherwise fall within it. This guarantees that calling .into_inner() immediately after a seek yields the underlying reader at the same position.

To seek without discarding the internal buffer, use BufReader::seek_relative.

See std::io::Seek for more details.

Note: In the edge case where you're seeking with SeekFrom::Current(n) where n minus the internal buffer length overflows an i64, two seeks will be performed instead of one. If the second seek returns Err, the underlying reader will be left at the same position it would have if you called seek with SeekFrom::Current(0).

Auto Trait Implementations

impl<R> RefUnwindSafe for BufReader<R> where
    R: RefUnwindSafe

impl<R> Send for BufReader<R> where
    R: Send

impl<R> Sync for BufReader<R> where
    R: Sync

impl<R> Unpin for BufReader<R> where
    R: Unpin

impl<R> UnwindSafe for BufReader<R> where
    R: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.