Struct ChannelRowSink 

pub struct ChannelRowSink { /* private fields */ }

A sink that streams finished strips to the async side over a bounded channel. Each strip is an owned [PixelBuffer]; provide_* hands the decoder a fresh strip and ships the previous one, blocking the decode thread while the channel is full, so a slow consumer throttles the decoder instead of the decoder filling memory.

It blocks, so it belongs on a thread outside the runtime: a Compute such as spawn_blocking or a rayon pool, or pull_decode_on_thread. Under Inline the batch runs on a runtime worker, where tokio refuses to block.

Implementations

impl ChannelRowSink

pub fn new(tx: Sender<StripEvent>, provisional: bool) -> Self

A sink sending into tx. provisional says whether progressive passes should be forwarded as they arrive.

pub fn with_pulse(self, pulse: SharedPulse) -> Self

Re-check pulse while blocked on a full channel, so a cancelled decode is not held hostage by a consumer that stopped consuming.

Trait Implementations

impl Debug for ChannelRowSink

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

Formats the value using the given formatter.

impl DecodeRowSink for ChannelRowSink

fn begin( &mut self, width: u32, height: u32, descriptor: PixelDescriptor, ) -> Result<(), SinkError>

Called once before the first strip with total output dimensions and pixel format.

fn provide_next_buffer( &mut self, y: u32, height: u32, width: u32, descriptor: PixelDescriptor, ) -> Result<PixelSliceMut<'_>, SinkError>

Provide a mutable pixel buffer for decoded rows y .. y + height.

fn accepts_provisional(&self) -> bool

Whether this sink wants provisional rows from progressive passes.

fn provide_pass_buffer( &mut self, meta: BatchMeta, height: u32, width: u32, descriptor: PixelDescriptor, ) -> Result<PixelSliceMut<'_>, SinkError>

Provide a buffer for provisional rows meta.y .. meta.y + height of pass meta.pass: an approximation a later pass replaces. Called only on sinks whose accepts_provisional returned true, never for final rows (meta.is_final is false), and in any order relative to other provisional rows. The final rows for the same region still arrive through provide_next_buffer.

fn finish(&mut self) -> Result<(), SinkError>

Called once after the last strip has been fully written.

fn max_buffer_rows(&self) -> NonZero<u32>

Largest strip the sink can lend without growing its admitted storage.