Struct SizeHint

pub struct SizeHint { /* private fields */ }

A Body size hint

The default implementation returns:

• 0 for lower
• None for upper.

Implementations

impl SizeHint

pub fn new() -> SizeHint

Returns a new SizeHint with default values

pub fn with_exact(value: u64) -> SizeHint

Returns a new SizeHint with both upper and lower bounds set to the given value.

pub fn lower(&self) -> u64

Returns the lower bound of data that the Body will yield before completing.

pub fn set_lower(&mut self, value: u64)

Set the value of the lower hint.

Panics

The function panics if value is greater than upper.

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

Returns the upper bound of data the Body will yield before completing, or None if the value is unknown.

pub fn set_upper(&mut self, value: u64)

Set the value of the upper hint value.

Panics

This function panics if value is less than lower.

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

Returns the exact size of data that will be yielded if the lower and upper bounds are equal.

pub fn set_exact(&mut self, value: u64)

Set the value of the lower and upper bounds to exactly the same.

Trait Implementations

impl Clone for SizeHint

fn clone(&self) -> SizeHint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SizeHint

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

Formats the value using the given formatter.

impl Default for SizeHint

fn default() -> SizeHint

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes