Struct Inspector

pub struct Inspector { /* private fields */ }

A collector for stream data, inspecting it chunk by chunk.

See the inspect_* functions on BroadcastOutputStream and SingleOutputStream.

For proper cleanup, call

• wait(), which waits for the collection task to complete.
• cancel(), which sends a termination signal and then waits for the collection task to complete.

If not cleaned up, the termination signal will be sent when dropping this collector, but the task will be aborted (forceful, not waiting for its regular completion).

Implementations

impl Inspector

pub fn is_finished(&self) -> bool

Checks if this task has finished.

pub async fn wait(self) -> Result<(), InspectorError>

Wait for the inspector to terminate naturally.

An inspector will automatically terminate when either:

1. The underlying write-side of the stream is dropped.
2. The underlying stream is closed (by receiving an EOF / final read of 0 bytes).
3. The first Next::Break is observed.

If none of these may occur in your case, this could/will hang forever!

pub async fn cancel(self) -> Result<(), InspectorError>

Sends a cancellation event to the inspector, letting it shut down.

Trait Implementations

impl Drop for Inspector

fn drop(&mut self)

Executes the destructor for this type.