Struct StreamReader

pub struct StreamReader {
    config: StreamConfig,
    state: StreamState,
    buffer: Vec<u8>,
    bytes_received: usize,
    expected_size: Option<usize>,
    bytes_since_progress: usize,
    progress_callback: Option<ProgressCallback>,
    cancelled: bool,
}

Streaming data reader with progress tracking.

Accumulates data chunks and provides progress updates.

Fields

config: StreamConfig

Configuration.

state: StreamState

Current state.

buffer: Vec<u8>

Accumulated data.

bytes_received: usize

Total bytes received.

expected_size: Option<usize>

Expected total size (from Content-Length).

bytes_since_progress: usize

Bytes since last progress callback.

progress_callback: Option<ProgressCallback>

Progress callback (stored as Option since fn pointers can’t be Debug).

cancelled: bool

Cancellation flag.

Implementations

impl StreamReader

pub fn new() -> Self

Create a new stream reader with default config.

pub fn with_buffer_size(buffer_size: usize) -> Self

Create with specific buffer size.

pub fn with_config(config: StreamConfig) -> Self

Create with full configuration.

pub fn set_expected_size(&mut self, size: Option<usize>)

Set expected total size (from Content-Length header).

pub fn expected_size(&self) -> Option<usize>

Get expected total size.

pub fn set_progress_callback(&mut self, callback: ProgressCallback)

Set progress callback.

pub fn state(&self) -> StreamState

Get current state.

pub fn is_complete(&self) -> bool

Check if transfer is complete.

pub fn is_cancelled(&self) -> bool

Check if transfer was cancelled.

pub fn bytes_received(&self) -> usize

Get bytes received so far.

pub fn progress_percent(&self) -> Option<u8>

Get progress as percentage (0-100).

pub fn cancel(&mut self)

Cancel the transfer.

pub fn feed(&mut self, data: &[u8]) -> Result<usize>

Feed data chunk to the reader.

Returns number of bytes consumed.

pub fn finish(&mut self)

Mark transfer as complete (for chunked encoding without Content-Length).

pub fn fail(&mut self)

Mark transfer as failed.

pub fn data(&self) -> &[u8]

Get accumulated data.

pub fn take_data(self) -> Vec<u8>

Take ownership of accumulated data.

pub fn clear_buffer(&mut self)

Clear buffer but keep state.

pub fn reset(&mut self)

Reset reader for reuse.

fn report_progress(&self)

Report progress via callback.

Trait Implementations

impl Debug for StreamReader

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

Formats the value using the given formatter.

impl Default for StreamReader

fn default() -> Self

Returns the “default value” for a type.