Trait Peek

pub trait Peek {
    // Required method
    fn peek(&mut self, buf: &mut [u8]) -> Result<usize>;
}

A trait providing the peek function for reading without consuming.

Many common Read implementations have Peek implementations, however Stdin, ChildStderr, ChildStdout, PipeReader, and CharDevice do not, since they are unbuffered and pipes and character devices don’t support any form of peeking.

Required Methods

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

Reads data from a stream without consuming it; subsequent reads will re-read the data. May return fewer bytes than requested; Ok(0) indicates that seeking is not possible (but reading may still be).

Implementations on Foreign Types

impl Peek for File

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

impl Peek for Empty

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

impl Peek for Repeat

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

impl Peek for TcpStream

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

impl Peek for UnixStream

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

impl<'a> Peek for &'a [u8]

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

impl<'a> Peek for StdinLock<'a>

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

impl<'a, B: BufRead + ?Sized> Peek for &'a mut B

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

impl<B: BufRead + ?Sized> Peek for Box<B>

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

impl<R: Read> Peek for BufReader<R>

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

impl<T> Peek for Cursor<T>

where T: AsRef<[u8]>,

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

impl<T: BufRead> Peek for Take<T>

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

impl<T: BufRead, U: BufRead> Peek for Chain<T, U>

fn peek(&mut self, buf: &mut [u8]) -> Result<usize>

Implementors