Struct PeekInterrupt 

pub struct PeekInterrupt { /* private fields */ }

Available on crate feature std only.

One-shot signal that tells protocol peeking to stop waiting for input.

Peekers find it in the Extensions of their input. Once triggered it stays triggered: whether a peek then falls back, fails or keeps waiting is decided by its PeekPolicy based on how far that peek got.

It is triggered explicitly via Self::trigger or by an attached PeekInterruptSource, e.g. the first byte probed by PeekEgressFirstByteLayer.

Implementations

impl PeekInterrupt

pub fn new() -> PeekInterrupt

Create a new PeekInterrupt that is not yet triggered.

pub fn trigger(&self)

Trigger the interrupt, waking all peeks waiting on it.

pub fn is_triggered(&self) -> bool

Returns true once the interrupt was triggered.

Attached sources are only polled by Self::triggered.

pub fn attach(&self, source: impl PeekInterruptSource)

Attach a source that triggers this interrupt once its condition is met.

pub async fn triggered(&self)

Wait until the interrupt is triggered, driving attached sources.

pub fn poll_triggered(&self, cx: &mut Context<'_>) -> Poll<()>

Poll version of Self::triggered.

Trait Implementations

impl Debug for PeekInterrupt

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

Formats the value using the given formatter.

impl Default for PeekInterrupt

fn default() -> PeekInterrupt

Returns the “default value” for a type.

impl Extension for PeekInterrupt