Struct PeekWaiter 

pub struct PeekWaiter { /* private fields */ }

Available on crate feature std only.

Reads peek input, bounded by a timeout and a PeekInterrupt as directed by a PeekPolicy.

The timeout starts when the waiter is created and covers all reads made through it, so share one waiter across the phases of a single peek. Input that is ready always wins over a cutoff.

Implementations

impl PeekWaiter

pub fn new(timeout: Option<Duration>) -> PeekWaiter

Create a waiter whose optional timeout starts now.

pub fn with_policy(self, policy: PeekPolicy) -> PeekWaiter

Set the PeekPolicy applied to cutoffs.

pub fn set_policy(&mut self, policy: PeekPolicy) -> &mut PeekWaiter

Set the PeekPolicy applied to cutoffs.

pub fn maybe_with_interrupt( self, interrupt: Option<Arc<PeekInterrupt>>, ) -> PeekWaiter

Set the PeekInterrupt that can cut the peek short, usually the one found in the input extensions.

pub fn maybe_set_interrupt( &mut self, interrupt: Option<Arc<PeekInterrupt>>, ) -> &mut PeekWaiter

Set the PeekInterrupt that can cut the peek short, usually the one found in the input extensions.

pub fn with_interrupt(self, interrupt: Arc<PeekInterrupt>) -> PeekWaiter

Set the PeekInterrupt that can cut the peek short, usually the one found in the input extensions.

pub fn set_interrupt( &mut self, interrupt: Arc<PeekInterrupt>, ) -> &mut PeekWaiter

Set the PeekInterrupt that can cut the peek short, usually the one found in the input extensions.

pub fn without_interrupt(self) -> PeekWaiter

Set the PeekInterrupt that can cut the peek short, usually the one found in the input extensions.

pub fn unset_interrupt(&mut self) -> &mut PeekWaiter

Set the PeekInterrupt that can cut the peek short, usually the one found in the input extensions.

pub async fn read<R>( &mut self, reader: &mut R, buf: &mut [u8], peeked: usize, ) -> PeekRead

where R: AsyncRead + Unpin + ?Sized,

Read into buf unless a cutoff stops the peek first.

peeked is the number of bytes this peek holds so far.

pub fn check<E>(&self) -> Result<(), E>

where E: From<PeekTimeoutError> + From<PeekInterruptedError>,

Returns the error of a cutoff for which the policy selected PeekAction::Fail.

Trait Implementations

impl Debug for PeekWaiter

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

Formats the value using the given formatter.

impl Default for PeekWaiter

fn default() -> PeekWaiter

Returns the “default value” for a type.