Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specialize io::Bytes::size_hint for more types #86202

Merged
merged 1 commit into from
Jun 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion library/std/src/io/buffered/bufreader.rs
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,13 @@ impl<R: Seek> Seek for BufReader<R> {
}

impl<T> SizeHint for BufReader<T> {
#[inline]
fn lower_bound(&self) -> usize {
self.buffer().len()
SizeHint::lower_bound(self.get_ref()) + self.buffer().len()
}

#[inline]
fn upper_bound(&self) -> Option<usize> {
SizeHint::upper_bound(self.get_ref()).and_then(|up| self.buffer().len().checked_add(up))
}
}
58 changes: 57 additions & 1 deletion library/std/src/io/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@
mod tests;

use crate::cmp;
use crate::convert::TryInto;
use crate::fmt;
use crate::ops::{Deref, DerefMut};
use crate::ptr;
Expand Down Expand Up @@ -2291,13 +2292,15 @@ impl<T: BufRead, U: BufRead> BufRead for Chain<T, U> {
}

impl<T, U> SizeHint for Chain<T, U> {
#[inline]
fn lower_bound(&self) -> usize {
SizeHint::lower_bound(&self.first) + SizeHint::lower_bound(&self.second)
}

#[inline]
fn upper_bound(&self) -> Option<usize> {
match (SizeHint::upper_bound(&self.first), SizeHint::upper_bound(&self.second)) {
(Some(first), Some(second)) => Some(first + second),
(Some(first), Some(second)) => first.checked_add(second),
_ => None,
}
}
Expand Down Expand Up @@ -2502,6 +2505,21 @@ impl<T: BufRead> BufRead for Take<T> {
}
}

impl<T> SizeHint for Take<T> {
#[inline]
fn lower_bound(&self) -> usize {
cmp::min(SizeHint::lower_bound(&self.inner) as u64, self.limit) as usize
a1phyr marked this conversation as resolved.
Show resolved Hide resolved
}

#[inline]
fn upper_bound(&self) -> Option<usize> {
match SizeHint::upper_bound(&self.inner) {
Some(upper_bound) => Some(cmp::min(upper_bound as u64, self.limit) as usize),
None => self.limit.try_into().ok(),
}
}
}

/// An iterator over `u8` values of a reader.
///
/// This struct is generally created by calling [`bytes`] on a reader.
Expand Down Expand Up @@ -2546,15 +2564,53 @@ trait SizeHint {
}

impl<T> SizeHint for T {
#[inline]
default fn lower_bound(&self) -> usize {
0
}

#[inline]
default fn upper_bound(&self) -> Option<usize> {
None
}
}

impl<T> SizeHint for &mut T {
#[inline]
fn lower_bound(&self) -> usize {
SizeHint::lower_bound(*self)
}

#[inline]
fn upper_bound(&self) -> Option<usize> {
SizeHint::upper_bound(*self)
}
}

impl<T> SizeHint for Box<T> {
#[inline]
fn lower_bound(&self) -> usize {
SizeHint::lower_bound(&**self)
}

#[inline]
fn upper_bound(&self) -> Option<usize> {
SizeHint::upper_bound(&**self)
}
}

impl SizeHint for &[u8] {
#[inline]
fn lower_bound(&self) -> usize {
self.len()
}

#[inline]
fn upper_bound(&self) -> Option<usize> {
Some(self.len())
}
}

/// An iterator over the contents of an instance of `BufRead` split on a
/// particular byte.
///
Expand Down
20 changes: 19 additions & 1 deletion library/std/src/io/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,24 @@ fn empty_size_hint() {
assert_eq!(size_hint, (0, Some(0)));
}

#[test]
fn slice_size_hint() {
let size_hint = (&[1, 2, 3]).bytes().size_hint();
assert_eq!(size_hint, (3, Some(3)));
}

#[test]
fn take_size_hint() {
let size_hint = (&[1, 2, 3]).take(2).bytes().size_hint();
assert_eq!(size_hint, (2, Some(2)));

let size_hint = (&[1, 2, 3]).take(4).bytes().size_hint();
assert_eq!(size_hint, (3, Some(3)));

let size_hint = io::repeat(0).take(3).bytes().size_hint();
assert_eq!(size_hint, (3, Some(3)));
}

#[test]
fn chain_empty_size_hint() {
let chain = io::empty().chain(io::empty());
Expand All @@ -242,7 +260,7 @@ fn chain_size_hint() {

let chain = buf_reader_1.chain(buf_reader_2);
let size_hint = chain.bytes().size_hint();
assert_eq!(size_hint, (testdata.len(), None));
assert_eq!(size_hint, (testdata.len(), Some(testdata.len())));
}

#[test]
Expand Down
13 changes: 13 additions & 0 deletions library/std/src/io/util.rs
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ impl fmt::Debug for Empty {
}

impl SizeHint for Empty {
#[inline]
fn upper_bound(&self) -> Option<usize> {
Some(0)
}
Expand Down Expand Up @@ -147,6 +148,18 @@ impl Read for Repeat {
}
}

impl SizeHint for Repeat {
#[inline]
fn lower_bound(&self) -> usize {
usize::MAX
}

#[inline]
fn upper_bound(&self) -> Option<usize> {
None
}
}

#[stable(feature = "std_debug", since = "1.16.0")]
impl fmt::Debug for Repeat {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
Expand Down