Struct StreamHandler 

pub struct StreamHandler { /* private fields */ }

StreamHandler is a lightweight helper for managing streamed responses.

It provides two main components:

• chunk_sender: An asynchronous channel sender used to forward each received chunk of data to a consumer in real time.
• abort: An optional abort flag that can be used to stop an ongoing curl perform operation from another thread.

This struct is typically used in combination with the Collector::Streaming variant to enable progressive consumption of large or continuous responses without buffering everything in memory.

Implementations

impl StreamHandler

pub fn new() -> (Self, UnboundedReceiver<Vec<u8>>)

Creates a new StreamHandler along with its corresponding receiver.

This convenience method sets up a channel for streaming data, returning both the StreamHandler (containing the sender) and the UnboundedReceiver for consuming chunks.

Returns

A tuple of:

• StreamHandler: The handler containing the sender and optional abort flag.
• UnboundedReceiver<Vec<u8>>: The receiving end for streamed chunks.

pub fn with_perform_aborter(self, abort: AbortPerform) -> Self

Associates an abort handle with this StreamHandler.

AbortPerform is a shared flag across threads that can be toggled to true in order to abort the curl perform operation prematurely.

Example

use curl_http_client::AbortPerform;
use curl_http_client::StreamHandler;

let (handler, rx) = StreamHandler::new();
let aborter = AbortPerform::new();
let handler = handler.with_perform_aborter(aborter);

Trait Implementations

impl Clone for StreamHandler

fn clone(&self) -> StreamHandler

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamHandler

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

Formats the value using the given formatter.