peek abstract method

FutureOr<BufferedSource> peek()

Returns a new BufferedSource that can read data from this BufferedSource without consuming it. The returned source becomes invalid once this source is next read or closed.

For example, we can use peek() to lookahead and read the same data multiple times.

final buffer = Buffer()
buffer.writeString("abcdefghi")

buffer.readString(3) // returns "abc", buffer contains "defghi"

final peek = buffer.peek()
peek.readString(3) // returns "def", buffer contains "defghi"
peek.readString(3) // returns "ghi", buffer contains "defghi"

buffer.readString(3) // returns "def", buffer contains "ghi"

Implementation

FutureOr<BufferedSource> peek();