Struct StreamDrive 

pub struct StreamDrive<'a> { /* private fields */ }

The fetch half of an open stream: a Future that pulls the blob into the fill store, paced on the reader’s cursor, and resolves once the fetch ends. Its outcome reaches the consumer through the VerifiedReader: a failure surfaces as a read error after the verified prefix before it.

Poll it for as long as the reader is read, apart from the reads — Self::alongside does exactly that. Dropping it before it resolves stops the fetch and ends the reader with an error.

Implementations

impl StreamDrive<'_>

pub async fn alongside<T>(&mut self, consume: impl Future<Output = T>) -> T

Run consume to completion while this drive runs beside it, and return consume’s output. The drive is polled first on every wake, so an open paid leg is never starved by a slow consumer. If the drive finishes first, consume keeps running to the end of the stream. If consume finishes first, the drive stays where it is: call this again to resume it, or drop it to stop the fetch.

pub const fn take_error(&mut self) -> Option<Error>

The error the fetch ended with, typed as the fetch returned it (a crate::GaveUp, a fatal fault, a unanimous verdict of the sources), once the drive has resolved with one. A reader error that follows a failed fetch carries only this error’s message, so a caller that needs to act on the error’s type takes it here.

Trait Implementations

impl Debug for StreamDrive<'_>

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

Formats the value using the given formatter.

impl Drop for StreamDrive<'_>

fn drop(&mut self)

A drive dropped before it resolves records a failure, so a reader still waiting on it ends with an error instead of hanging.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Future for StreamDrive<'_>

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.