A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://github.com/rust-lang/libs-team/issues/417 below:

peek · Issue #417 · rust-lang/libs-team · GitHub

Proposal Problem statement

It is often desirable to look ahead a small amount in an unseekable stream, such as a unix pipe.

Motivating examples or use cases

the main usecase is inspecting the magic number of a file, such as is trying to be done here, but it could also be useful for some simple parsers.

Solution sketch

add a method BufReader::peek that has the signature fn peek(&mut self, n: usize) -> io::Result<&[u8]>

the method would work as followed:

  1. clear from the front of the buffer any consumed bytes
  2. do read calls on the underlying Read object to fill the buffer until it reaches any of: the length requested, the BufReader's capacity, or end of file
  3. return the slice of this new buffer
Alternatives
  1. give it the same signature as Read::read (adds an extra copy, but has nice parity)
  2. a Peek trait that abstracts over all streams that can do a limited lookahead
  3. instead of limiting the lookahead to the capacity of the buffer, automatically grow the buffer if a larger lookahead is requested (less performant and more complexity)
  4. leave this up to other crates (this would require those other crates to reimplement basically all of BufReader)
Links and related work

original thread linked previously

What happens now?

This issue contains an API change proposal (or ACP) and is part of the libs-api team feature lifecycle. Once this issue is filed, the libs-api team will review open proposals as capability becomes available. Current response times do not have a clear estimate, but may be up to several months.

Possible responses

The libs team may respond in various different ways. First, the team will consider the problem (this doesn't require any concrete solution or alternatives to have been proposed):

Second, if there's a concrete solution:


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4