Skip to main content

AsyncCursor

Struct AsyncCursor 

Source
pub struct AsyncCursor { /* private fields */ }
Expand description

Drives any ByteStepper from an AsyncSource: the async twin of ReadAtCursor.

Each next steps the stage on the calling task and awaits the source only when the stage needs bytes, so a container demuxer (cheap per step) streams packets from a socket or an object store without holding a thread during I/O and without becoming async itself. Range requests are coalesced and fetched with one AsyncSource::read_ranges per round. CPU-heavy stages (image decoders) use decode_async, which moves the work off the async runtime.

Implementations§

Source§

impl AsyncCursor

Source

pub fn new(opts: DriveOptions) -> Self

A cursor with the given read sizes.

Source

pub fn retained_input_capacity(&self) -> usize

Retained driver-owned payload capacity, excluding source caches and outputs.

Source

pub async fn next<S, Src>( &mut self, source: &mut Src, stage: &mut S, pulse: Option<&dyn Pulse>, ) -> Result<Yield<S::Output>, DriveFailure<S::Error, BoxedError>>
where S: ByteStepper + ?Sized, Src: AsyncSource + ?Sized,

Step stage until it produces an output, awaiting source for every request. Pass the same source on every call.

Trait Implementations§

Source§

impl Debug for AsyncCursor

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.