Struct StreamHandle 

pub struct StreamHandle { /* private fields */ }

Minimal stream handle abstraction for long-lived streaming tasks.

Lifecycle contract:

• Prefer calling stop to request a graceful shutdown and await completion.
• Call abort for immediate, non-graceful termination.
• If dropped without an explicit shutdown, a best-effort stop signal is sent (if available) and the underlying task is then aborted. The task may not observe the stop signal before abort.

Implementations

impl StreamHandle

pub const fn new(inner: JoinHandle<()>, stop_tx: Sender<()>) -> Self

Create a new StreamHandle.

Parameters:

• inner: the spawned task driving the stream.
• stop_tx: a one-shot used to request a graceful stop.

Returns a handle that can be used to stop or abort the stream.

pub const fn new_abort_only(inner: JoinHandle<()>) -> Self

Create a StreamHandle that can only abort the task (no graceful stop).

This constructor is intended for connectors that do not support a cooperative shutdown signal. Dropping the handle (or calling abort) will force-cancel the underlying task.

pub async fn stop(self)

Gracefully stop the underlying stream task and await its completion.

Sends a stop signal if available, then awaits the task. Any errors from the task are ignored.

pub fn abort(self)

Force-abort the underlying stream task without waiting for completion.

Prefer stop when possible to allow cleanup.

Trait Implementations

impl Debug for StreamHandle

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

Formats the value using the given formatter.

impl Drop for StreamHandle

fn drop(&mut self)

Executes the destructor for this type.