Struct BytesHint 

pub struct BytesHint(/* private fields */);

Returns the bounds on the remaining bytes of the stream.

Specifically, bytes_hint() returns a tuple where the first element is the lower bound, and the second element is the upper bound.

The second half of the tuple that is returned is an Option<u64>. A None here means that either there is no known upper bound, or the upper bound is larger than u64.

Implementations

impl BytesHint

pub fn new(lower_bound: u64, upper_bound: Option<u64>) -> BytesHint

pub fn new_exact(bytes: u64) -> BytesHint

An exact number of bytes will be returned.

pub fn new_at_max(bytes: u64) -> BytesHint

Create a hint of min=0 and max=bytes bytes

pub fn new_no_hint() -> BytesHint

Creates a new hint which gives no hint at all.

(0, None)

pub fn lower_bound(&self) -> u64

Returns the lower bound

pub fn upper_bound(&self) -> Option<u64>

A None here means that either there is no known upper bound, or the upper bound is larger than usize.

pub fn is_exact(&self) -> bool

Returns true if this hint is an exact hint.

This means that the lower bound must equal the upper bound: (a, Some(a)).

pub fn exact(&self) -> Option<u64>

Returns the exact bytes if size hint specifies an exact amount of bytes.

This means that the lower bound must equal the upper bound: (a, Some(a)).

pub fn reduce_by(&mut self, by: u64)

Bytes have been send and by less will be received from now on

pub fn combine(self, other: BytesHint) -> BytesHint

pub fn into_inner(self) -> (u64, Option<u64>)

Turns this into the inner tuple

Trait Implementations

impl Clone for BytesHint

fn clone(&self) -> BytesHint

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BytesHint

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for BytesHint

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for BytesHint

fn eq(&self, other: &BytesHint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BytesHint

impl Eq for BytesHint

impl StructuralPartialEq for BytesHint